Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. monitor
  5. getAzureMonitorWorkspace
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.monitor.getAzureMonitorWorkspace

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Returns the specific Azure Monitor workspace

    Uses Azure REST API version 2023-10-01-preview.

    Other available API versions: 2023-04-03. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native monitor [ApiVersion]. See the version guide for details.

    Using getAzureMonitorWorkspace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAzureMonitorWorkspace(args: GetAzureMonitorWorkspaceArgs, opts?: InvokeOptions): Promise<GetAzureMonitorWorkspaceResult>
function getAzureMonitorWorkspaceOutput(args: GetAzureMonitorWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetAzureMonitorWorkspaceResult>
    def get_azure_monitor_workspace(azure_monitor_workspace_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetAzureMonitorWorkspaceResult
def get_azure_monitor_workspace_output(azure_monitor_workspace_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetAzureMonitorWorkspaceResult]
    func LookupAzureMonitorWorkspace(ctx *Context, args *LookupAzureMonitorWorkspaceArgs, opts ...InvokeOption) (*LookupAzureMonitorWorkspaceResult, error)
func LookupAzureMonitorWorkspaceOutput(ctx *Context, args *LookupAzureMonitorWorkspaceOutputArgs, opts ...InvokeOption) LookupAzureMonitorWorkspaceResultOutput

    > Note: This function is named LookupAzureMonitorWorkspace in the Go SDK.

    public static class GetAzureMonitorWorkspace 
{
    public static Task<GetAzureMonitorWorkspaceResult> InvokeAsync(GetAzureMonitorWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetAzureMonitorWorkspaceResult> Invoke(GetAzureMonitorWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAzureMonitorWorkspaceResult> getAzureMonitorWorkspace(GetAzureMonitorWorkspaceArgs args, InvokeOptions options)
public static Output<GetAzureMonitorWorkspaceResult> getAzureMonitorWorkspace(GetAzureMonitorWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:monitor:getAzureMonitorWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AzureMonitorWorkspaceName string
    The name of the Azure Monitor workspace. The name is case insensitive.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AzureMonitorWorkspaceName string
    The name of the Azure Monitor workspace. The name is case insensitive.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    azureMonitorWorkspaceName String
    The name of the Azure Monitor workspace. The name is case insensitive.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    azureMonitorWorkspaceName string
    The name of the Azure Monitor workspace. The name is case insensitive.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    azure_monitor_workspace_name str
    The name of the Azure Monitor workspace. The name is case insensitive.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    azureMonitorWorkspaceName String
    The name of the Azure Monitor workspace. The name is case insensitive.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAzureMonitorWorkspace Result

    The following output properties are available:

    AccountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    AzureApiVersion string
    The Azure API version of the resource.
    DefaultIngestionSettings Pulumi.AzureNative.Monitor.Outputs.IngestionSettingsResponse
    The Data Collection Rule and Endpoint used for ingestion by default.
    Etag string
    Resource entity tag (ETag)
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivateEndpointConnections List<Pulumi.AzureNative.Monitor.Outputs.PrivateEndpointConnectionResponse>
    List of private endpoint connections.
    ProvisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    PublicNetworkAccess string
    Gets or sets allow or disallow public network access to workspace
    SystemData Pulumi.AzureNative.Monitor.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Metrics Pulumi.AzureNative.Monitor.Outputs.MetricsResponse
    Information about metrics for the Azure Monitor workspace
    Tags Dictionary<string, string>
    Resource tags.
    AccountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    AzureApiVersion string
    The Azure API version of the resource.
    DefaultIngestionSettings IngestionSettingsResponse
    The Data Collection Rule and Endpoint used for ingestion by default.
    Etag string
    Resource entity tag (ETag)
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    List of private endpoint connections.
    ProvisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    PublicNetworkAccess string
    Gets or sets allow or disallow public network access to workspace
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Metrics MetricsResponse
    Information about metrics for the Azure Monitor workspace
    Tags map[string]string
    Resource tags.
    accountId String
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    azureApiVersion String
    The Azure API version of the resource.
    defaultIngestionSettings IngestionSettingsResponse
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag String
    Resource entity tag (ETag)
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    List of private endpoint connections.
    provisioningState String
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    publicNetworkAccess String
    Gets or sets allow or disallow public network access to workspace
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    metrics MetricsResponse
    Information about metrics for the Azure Monitor workspace
    tags Map<String,String>
    Resource tags.
    accountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    azureApiVersion string
    The Azure API version of the resource.
    defaultIngestionSettings IngestionSettingsResponse
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag string
    Resource entity tag (ETag)
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    List of private endpoint connections.
    provisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    publicNetworkAccess string
    Gets or sets allow or disallow public network access to workspace
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    metrics MetricsResponse
    Information about metrics for the Azure Monitor workspace
    tags {[key: string]: string}
    Resource tags.
    account_id str
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    azure_api_version str
    The Azure API version of the resource.
    default_ingestion_settings IngestionSettingsResponse
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag str
    Resource entity tag (ETag)
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    List of private endpoint connections.
    provisioning_state str
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    public_network_access str
    Gets or sets allow or disallow public network access to workspace
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    metrics MetricsResponse
    Information about metrics for the Azure Monitor workspace
    tags Mapping[str, str]
    Resource tags.
    accountId String
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    azureApiVersion String
    The Azure API version of the resource.
    defaultIngestionSettings Property Map
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag String
    Resource entity tag (ETag)
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    privateEndpointConnections List<Property Map>
    List of private endpoint connections.
    provisioningState String
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    publicNetworkAccess String
    Gets or sets allow or disallow public network access to workspace
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    metrics Property Map
    Information about metrics for the Azure Monitor workspace
    tags Map<String>
    Resource tags.

    Supporting Types

    IngestionSettingsResponse

    DataCollectionEndpointResourceId string
    The Azure resource Id of the default data collection endpoint for this workspace.
    DataCollectionRuleResourceId string
    The Azure resource Id of the default data collection rule for this workspace.
    DataCollectionEndpointResourceId string
    The Azure resource Id of the default data collection endpoint for this workspace.
    DataCollectionRuleResourceId string
    The Azure resource Id of the default data collection rule for this workspace.
    dataCollectionEndpointResourceId String
    The Azure resource Id of the default data collection endpoint for this workspace.
    dataCollectionRuleResourceId String
    The Azure resource Id of the default data collection rule for this workspace.
    dataCollectionEndpointResourceId string
    The Azure resource Id of the default data collection endpoint for this workspace.
    dataCollectionRuleResourceId string
    The Azure resource Id of the default data collection rule for this workspace.
    data_collection_endpoint_resource_id str
    The Azure resource Id of the default data collection endpoint for this workspace.
    data_collection_rule_resource_id str
    The Azure resource Id of the default data collection rule for this workspace.
    dataCollectionEndpointResourceId String
    The Azure resource Id of the default data collection endpoint for this workspace.
    dataCollectionRuleResourceId String
    The Azure resource Id of the default data collection rule for this workspace.

    MetricsResponse

    InternalId string
    An internal identifier for the metrics container. Only to be used by the system
    PrometheusQueryEndpoint string
    The Prometheus query endpoint for the workspace
    InternalId string
    An internal identifier for the metrics container. Only to be used by the system
    PrometheusQueryEndpoint string
    The Prometheus query endpoint for the workspace
    internalId String
    An internal identifier for the metrics container. Only to be used by the system
    prometheusQueryEndpoint String
    The Prometheus query endpoint for the workspace
    internalId string
    An internal identifier for the metrics container. Only to be used by the system
    prometheusQueryEndpoint string
    The Prometheus query endpoint for the workspace
    internal_id str
    An internal identifier for the metrics container. Only to be used by the system
    prometheus_query_endpoint str
    The Prometheus query endpoint for the workspace
    internalId String
    An internal identifier for the metrics container. Only to be used by the system
    prometheusQueryEndpoint String
    The Prometheus query endpoint for the workspace

    PrivateEndpointConnectionResponse

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Monitor.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    GroupIds List<string>
    The group ids for the private endpoint resource.
    PrivateEndpoint Pulumi.AzureNative.Monitor.Inputs.PrivateEndpointResponse
    The resource of private end point.
    SystemData Pulumi.AzureNative.Monitor.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    GroupIds []string
    The group ids for the private endpoint resource.
    PrivateEndpoint PrivateEndpointResponse
    The resource of private end point.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds List<String>
    The group ids for the private endpoint resource.
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The provisioning state of the private endpoint connection resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds string[]
    The group ids for the private endpoint resource.
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The provisioning state of the private endpoint connection resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    group_ids Sequence[str]
    The group ids for the private endpoint resource.
    private_endpoint PrivateEndpointResponse
    The resource of private end point.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds List<String>
    The group ids for the private endpoint resource.
    privateEndpoint Property Map
    The resource of private end point.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.

    PrivateEndpointResponse

    Id string
    The ARM identifier for Private Endpoint
    Id string
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint
    id string
    The ARM identifier for Private Endpoint
    id str
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native