1. Packages
  2. Azure Native v1
  3. API Docs
  4. monitor
  5. AzureMonitorWorkspace
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

azure-native.monitor.AzureMonitorWorkspace

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

    An Azure Monitor Workspace definition API Version: 2021-06-03-preview.

    Example Usage

    Create or update workspace

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var azureMonitorWorkspace = new AzureNative.Monitor.AzureMonitorWorkspace("azureMonitorWorkspace", new()
        {
            AzureMonitorWorkspaceName = "myAzureMonitorWorkspace",
            Location = "eastus",
            ResourceGroupName = "myResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	monitor "github.com/pulumi/pulumi-azure-native-sdk/monitor"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := monitor.NewAzureMonitorWorkspace(ctx, "azureMonitorWorkspace", &monitor.AzureMonitorWorkspaceArgs{
    			AzureMonitorWorkspaceName: pulumi.String("myAzureMonitorWorkspace"),
    			Location:                  pulumi.String("eastus"),
    			ResourceGroupName:         pulumi.String("myResourceGroup"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.monitor.AzureMonitorWorkspace;
    import com.pulumi.azurenative.monitor.AzureMonitorWorkspaceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var azureMonitorWorkspace = new AzureMonitorWorkspace("azureMonitorWorkspace", AzureMonitorWorkspaceArgs.builder()        
                .azureMonitorWorkspaceName("myAzureMonitorWorkspace")
                .location("eastus")
                .resourceGroupName("myResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    azure_monitor_workspace = azure_native.monitor.AzureMonitorWorkspace("azureMonitorWorkspace",
        azure_monitor_workspace_name="myAzureMonitorWorkspace",
        location="eastus",
        resource_group_name="myResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const azureMonitorWorkspace = new azure_native.monitor.AzureMonitorWorkspace("azureMonitorWorkspace", {
        azureMonitorWorkspaceName: "myAzureMonitorWorkspace",
        location: "eastus",
        resourceGroupName: "myResourceGroup",
    });
    
    resources:
      azureMonitorWorkspace:
        type: azure-native:monitor:AzureMonitorWorkspace
        properties:
          azureMonitorWorkspaceName: myAzureMonitorWorkspace
          location: eastus
          resourceGroupName: myResourceGroup
    

    Create AzureMonitorWorkspace Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AzureMonitorWorkspace(name: string, args: AzureMonitorWorkspaceArgs, opts?: CustomResourceOptions);
    @overload
    def AzureMonitorWorkspace(resource_name: str,
                              args: AzureMonitorWorkspaceArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def AzureMonitorWorkspace(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              resource_group_name: Optional[str] = None,
                              azure_monitor_workspace_name: Optional[str] = None,
                              location: Optional[str] = None,
                              tags: Optional[Mapping[str, str]] = None)
    func NewAzureMonitorWorkspace(ctx *Context, name string, args AzureMonitorWorkspaceArgs, opts ...ResourceOption) (*AzureMonitorWorkspace, error)
    public AzureMonitorWorkspace(string name, AzureMonitorWorkspaceArgs args, CustomResourceOptions? opts = null)
    public AzureMonitorWorkspace(String name, AzureMonitorWorkspaceArgs args)
    public AzureMonitorWorkspace(String name, AzureMonitorWorkspaceArgs args, CustomResourceOptions options)
    
    type: azure-native:monitor:AzureMonitorWorkspace
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AzureMonitorWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AzureMonitorWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AzureMonitorWorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureMonitorWorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureMonitorWorkspaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureMonitorWorkspaceResource = new AzureNative.Monitor.AzureMonitorWorkspace("azureMonitorWorkspaceResource", new()
    {
        ResourceGroupName = "string",
        AzureMonitorWorkspaceName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := monitor.NewAzureMonitorWorkspace(ctx, "azureMonitorWorkspaceResource", &monitor.AzureMonitorWorkspaceArgs{
    	ResourceGroupName:         "string",
    	AzureMonitorWorkspaceName: "string",
    	Location:                  "string",
    	Tags: map[string]interface{}{
    		"string": "string",
    	},
    })
    
    var azureMonitorWorkspaceResource = new AzureMonitorWorkspace("azureMonitorWorkspaceResource", AzureMonitorWorkspaceArgs.builder()
        .resourceGroupName("string")
        .azureMonitorWorkspaceName("string")
        .location("string")
        .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
        .build());
    
    azure_monitor_workspace_resource = azure_native.monitor.AzureMonitorWorkspace("azureMonitorWorkspaceResource",
        resource_group_name=string,
        azure_monitor_workspace_name=string,
        location=string,
        tags={
            string: string,
        })
    
    const azureMonitorWorkspaceResource = new azure_native.monitor.AzureMonitorWorkspace("azureMonitorWorkspaceResource", {
        resourceGroupName: "string",
        azureMonitorWorkspaceName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:monitor:AzureMonitorWorkspace
    properties:
        azureMonitorWorkspaceName: string
        location: string
        resourceGroupName: string
        tags:
            string: string
    

    AzureMonitorWorkspace Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AzureMonitorWorkspace resource accepts the following input properties:

    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
    Location string
    The geo-location where the resource lives
    Tags Dictionary<string, string>
    Resource tags.
    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
    Location string
    The geo-location where the resource lives
    Tags map[string]string
    Resource tags.
    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
    location String
    The geo-location where the resource lives
    tags Map<String,String>
    Resource tags.
    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
    location string
    The geo-location where the resource lives
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    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
    location str
    The geo-location where the resource lives
    tags Mapping[str, str]
    Resource tags.
    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
    location String
    The geo-location where the resource lives
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AzureMonitorWorkspace resource produces the following output properties:

    AccountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    DefaultIngestionSettings Pulumi.AzureNative.Monitor.Outputs.AzureMonitorWorkspaceResponseDefaultIngestionSettings
    The Data Collection Rule and Endpoint used for ingestion by default.
    Etag string
    Resource entity tag (ETag)
    Id string
    The provider-assigned unique ID for this managed resource.
    Metrics Pulumi.AzureNative.Monitor.Outputs.AzureMonitorWorkspaceResponseMetrics
    Information about metrics for the Azure Monitor workspace
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"
    AccountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    DefaultIngestionSettings AzureMonitorWorkspaceResponseDefaultIngestionSettings
    The Data Collection Rule and Endpoint used for ingestion by default.
    Etag string
    Resource entity tag (ETag)
    Id string
    The provider-assigned unique ID for this managed resource.
    Metrics AzureMonitorWorkspaceResponseMetrics
    Information about metrics for the Azure Monitor workspace
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"
    accountId String
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    defaultIngestionSettings AzureMonitorWorkspaceResponseDefaultIngestionSettings
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag String
    Resource entity tag (ETag)
    id String
    The provider-assigned unique ID for this managed resource.
    metrics AzureMonitorWorkspaceResponseMetrics
    Information about metrics for the Azure Monitor workspace
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"
    accountId string
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    defaultIngestionSettings AzureMonitorWorkspaceResponseDefaultIngestionSettings
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag string
    Resource entity tag (ETag)
    id string
    The provider-assigned unique ID for this managed resource.
    metrics AzureMonitorWorkspaceResponseMetrics
    Information about metrics for the Azure Monitor workspace
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"
    account_id str
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    default_ingestion_settings AzureMonitorWorkspaceResponseDefaultIngestionSettings
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag str
    Resource entity tag (ETag)
    id str
    The provider-assigned unique ID for this managed resource.
    metrics AzureMonitorWorkspaceResponseMetrics
    Information about metrics for the Azure Monitor workspace
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"
    accountId String
    The immutable ID of the Azure Monitor workspace. This property is read-only.
    defaultIngestionSettings Property Map
    The Data Collection Rule and Endpoint used for ingestion by default.
    etag String
    Resource entity tag (ETag)
    id String
    The provider-assigned unique ID for this managed resource.
    metrics Property Map
    Information about metrics for the Azure Monitor workspace
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the Azure Monitor workspace. Set to Succeeded if everything is healthy.
    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"

    Supporting Types

    AzureMonitorWorkspaceResponseDefaultIngestionSettings, AzureMonitorWorkspaceResponseDefaultIngestionSettingsArgs

    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.

    AzureMonitorWorkspaceResponseMetrics, AzureMonitorWorkspaceResponseMetricsArgs

    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

    SystemDataResponse, SystemDataResponseArgs

    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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:monitor:AzureMonitorWorkspace myAzureMonitorWorkspace /subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Monitor/accounts/myAzureMonitorWorkspace 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi