@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The top level Workspace resource container.
*
* Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-10-01.
*
* Other available API versions: 2015-11-01-preview, 2020-03-01-preview, 2020-08-01, 2020-10-01, 2021-06-01, 2021-12-01-preview, 2022-10-01, 2025-02-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native operationalinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Workspace extends pulumi.CustomResource {
/**
* Get an existing Workspace resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Workspace;
/**
* Returns true if the given object is an instance of Workspace. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Workspace;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Workspace creation date.
*/
readonly createdDate: pulumi.Output<string>;
/**
* This is a read-only property. Represents the ID associated with the workspace.
*/
readonly customerId: pulumi.Output<string>;
/**
* The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
*/
readonly defaultDataCollectionRuleResourceId: pulumi.Output<string | undefined>;
/**
* The etag of the workspace.
*/
readonly etag: pulumi.Output<string | undefined>;
/**
* Workspace features.
*/
readonly features: pulumi.Output<outputs.operationalinsights.WorkspaceFeaturesResponse | undefined>;
/**
* Indicates whether customer managed storage is mandatory for query management.
*/
readonly forceCmkForQuery: pulumi.Output<boolean | undefined>;
/**
* The identity of the resource.
*/
readonly identity: pulumi.Output<outputs.operationalinsights.IdentityResponse | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* Workspace modification date.
*/
readonly modifiedDate: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* List of linked private link scope resources.
*/
readonly privateLinkScopedResources: pulumi.Output<outputs.operationalinsights.PrivateLinkScopedResourceResponse[]>;
/**
* The provisioning state of the workspace.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The network access type for accessing Log Analytics ingestion.
*/
readonly publicNetworkAccessForIngestion: pulumi.Output<string | undefined>;
/**
* The network access type for accessing Log Analytics query.
*/
readonly publicNetworkAccessForQuery: pulumi.Output<string | undefined>;
/**
* The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
*/
readonly retentionInDays: pulumi.Output<number | undefined>;
/**
* The SKU of the workspace.
*/
readonly sku: pulumi.Output<outputs.operationalinsights.WorkspaceSkuResponse | undefined>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.operationalinsights.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* The daily volume cap for ingestion.
*/
readonly workspaceCapping: pulumi.Output<outputs.operationalinsights.WorkspaceCappingResponse | undefined>;
/**
* Create a Workspace resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkspaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Workspace resource.
*/
export interface WorkspaceArgs {
/**
* The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
*/
defaultDataCollectionRuleResourceId?: pulumi.Input<string>;
/**
* Workspace features.
*/
features?: pulumi.Input<inputs.operationalinsights.WorkspaceFeaturesArgs>;
/**
* Indicates whether customer managed storage is mandatory for query management.
*/
forceCmkForQuery?: pulumi.Input<boolean>;
/**
* The identity of the resource.
*/
identity?: pulumi.Input<inputs.operationalinsights.IdentityArgs>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The network access type for accessing Log Analytics ingestion.
*/
publicNetworkAccessForIngestion?: pulumi.Input<string | enums.operationalinsights.PublicNetworkAccessType>;
/**
* The network access type for accessing Log Analytics query.
*/
publicNetworkAccessForQuery?: pulumi.Input<string | enums.operationalinsights.PublicNetworkAccessType>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
*/
retentionInDays?: pulumi.Input<number>;
/**
* The SKU of the workspace.
*/
sku?: pulumi.Input<inputs.operationalinsights.WorkspaceSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The daily volume cap for ingestion.
*/
workspaceCapping?: pulumi.Input<inputs.operationalinsights.WorkspaceCappingArgs>;
/**
* The name of the workspace.
*/
workspaceName?: pulumi.Input<string>;
}