1. Packages
  2. Azure Native
  3. API Docs
  4. insights
  5. MyWorkbook
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

azure-native.insights.MyWorkbook

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi

    An Application Insights private workbook definition. Azure REST API version: 2021-03-08. Prior API version in Azure Native 1.x: 2020-10-20.

    Import

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

    $ pulumi import azure-native:insights:MyWorkbook deadb33f-8bee-4d3b-a059-9be8dac93960 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/myWorkbooks/{resourceName} 
    

    Create MyWorkbook Resource

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

    Constructor syntax

    new MyWorkbook(name: string, args: MyWorkbookArgs, opts?: CustomResourceOptions);
    @overload
    def MyWorkbook(resource_name: str,
                   args: MyWorkbookArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def MyWorkbook(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   display_name: Optional[str] = None,
                   serialized_data: Optional[str] = None,
                   category: Optional[str] = None,
                   identity: Optional[MyWorkbookManagedIdentityArgs] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   kind: Optional[Union[str, Kind]] = None,
                   resource_name_: Optional[str] = None,
                   id: Optional[str] = None,
                   source_id: Optional[str] = None,
                   storage_uri: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   type: Optional[str] = None,
                   version: Optional[str] = None)
    func NewMyWorkbook(ctx *Context, name string, args MyWorkbookArgs, opts ...ResourceOption) (*MyWorkbook, error)
    public MyWorkbook(string name, MyWorkbookArgs args, CustomResourceOptions? opts = null)
    public MyWorkbook(String name, MyWorkbookArgs args)
    public MyWorkbook(String name, MyWorkbookArgs args, CustomResourceOptions options)
    
    type: azure-native:insights:MyWorkbook
    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 MyWorkbookArgs
    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 MyWorkbookArgs
    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 MyWorkbookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MyWorkbookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MyWorkbookArgs
    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 myWorkbookResource = new AzureNative.Insights.MyWorkbook("myWorkbookResource", new()
    {
        ResourceGroupName = "string",
        DisplayName = "string",
        SerializedData = "string",
        Category = "string",
        Identity = new AzureNative.Insights.Inputs.MyWorkbookManagedIdentityArgs
        {
            Type = "string",
        },
        Location = "string",
        Name = "string",
        Kind = "string",
        ResourceName = "string",
        Id = "string",
        SourceId = "string",
        StorageUri = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Type = "string",
        Version = "string",
    });
    
    example, err := insights.NewMyWorkbook(ctx, "myWorkbookResource", &insights.MyWorkbookArgs{
    	ResourceGroupName: pulumi.String("string"),
    	DisplayName:       pulumi.String("string"),
    	SerializedData:    pulumi.String("string"),
    	Category:          pulumi.String("string"),
    	Identity: &insights.MyWorkbookManagedIdentityArgs{
    		Type: pulumi.String("string"),
    	},
    	Location:     pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	Kind:         pulumi.String("string"),
    	ResourceName: pulumi.String("string"),
    	Id:           pulumi.String("string"),
    	SourceId:     pulumi.String("string"),
    	StorageUri:   pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Type:    pulumi.String("string"),
    	Version: pulumi.String("string"),
    })
    
    var myWorkbookResource = new MyWorkbook("myWorkbookResource", MyWorkbookArgs.builder()
        .resourceGroupName("string")
        .displayName("string")
        .serializedData("string")
        .category("string")
        .identity(MyWorkbookManagedIdentityArgs.builder()
            .type("string")
            .build())
        .location("string")
        .name("string")
        .kind("string")
        .resourceName("string")
        .id("string")
        .sourceId("string")
        .storageUri("string")
        .tags(Map.of("string", "string"))
        .type("string")
        .version("string")
        .build());
    
    my_workbook_resource = azure_native.insights.MyWorkbook("myWorkbookResource",
        resource_group_name="string",
        display_name="string",
        serialized_data="string",
        category="string",
        identity={
            "type": "string",
        },
        location="string",
        name="string",
        kind="string",
        resource_name_="string",
        id="string",
        source_id="string",
        storage_uri="string",
        tags={
            "string": "string",
        },
        type="string",
        version="string")
    
    const myWorkbookResource = new azure_native.insights.MyWorkbook("myWorkbookResource", {
        resourceGroupName: "string",
        displayName: "string",
        serializedData: "string",
        category: "string",
        identity: {
            type: "string",
        },
        location: "string",
        name: "string",
        kind: "string",
        resourceName: "string",
        id: "string",
        sourceId: "string",
        storageUri: "string",
        tags: {
            string: "string",
        },
        type: "string",
        version: "string",
    });
    
    type: azure-native:insights:MyWorkbook
    properties:
        category: string
        displayName: string
        id: string
        identity:
            type: string
        kind: string
        location: string
        name: string
        resourceGroupName: string
        resourceName: string
        serializedData: string
        sourceId: string
        storageUri: string
        tags:
            string: string
        type: string
        version: string
    

    MyWorkbook Resource Properties

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

    Inputs

    The MyWorkbook resource accepts the following input properties:

    Category string
    Workbook category, as defined by the user at creation time.
    DisplayName string
    The user-defined name of the private workbook.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SerializedData string
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    Id string
    Azure resource Id
    Identity Pulumi.AzureNative.Insights.Inputs.MyWorkbookManagedIdentity
    Identity used for BYOS
    Kind string | Pulumi.AzureNative.Insights.Kind
    The kind of workbook. Choices are user and shared.
    Location string
    Resource location
    Name string
    Azure resource name
    ResourceName string
    The name of the Application Insights component resource.
    SourceId string
    Optional resourceId for a source resource.
    StorageUri string
    BYOS Storage Account URI
    Tags Dictionary<string, string>
    Resource tags
    Type string
    Azure resource type
    Version string
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.
    Category string
    Workbook category, as defined by the user at creation time.
    DisplayName string
    The user-defined name of the private workbook.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SerializedData string
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    Id string
    Azure resource Id
    Identity MyWorkbookManagedIdentityArgs
    Identity used for BYOS
    Kind string | Kind
    The kind of workbook. Choices are user and shared.
    Location string
    Resource location
    Name string
    Azure resource name
    ResourceName string
    The name of the Application Insights component resource.
    SourceId string
    Optional resourceId for a source resource.
    StorageUri string
    BYOS Storage Account URI
    Tags map[string]string
    Resource tags
    Type string
    Azure resource type
    Version string
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.
    category String
    Workbook category, as defined by the user at creation time.
    displayName String
    The user-defined name of the private workbook.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serializedData String
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    id String
    Azure resource Id
    identity MyWorkbookManagedIdentity
    Identity used for BYOS
    kind String | Kind
    The kind of workbook. Choices are user and shared.
    location String
    Resource location
    name String
    Azure resource name
    resourceName String
    The name of the Application Insights component resource.
    sourceId String
    Optional resourceId for a source resource.
    storageUri String
    BYOS Storage Account URI
    tags Map<String,String>
    Resource tags
    type String
    Azure resource type
    version String
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.
    category string
    Workbook category, as defined by the user at creation time.
    displayName string
    The user-defined name of the private workbook.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serializedData string
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    id string
    Azure resource Id
    identity MyWorkbookManagedIdentity
    Identity used for BYOS
    kind string | Kind
    The kind of workbook. Choices are user and shared.
    location string
    Resource location
    name string
    Azure resource name
    resourceName string
    The name of the Application Insights component resource.
    sourceId string
    Optional resourceId for a source resource.
    storageUri string
    BYOS Storage Account URI
    tags {[key: string]: string}
    Resource tags
    type string
    Azure resource type
    version string
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.
    category str
    Workbook category, as defined by the user at creation time.
    display_name str
    The user-defined name of the private workbook.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    serialized_data str
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    id str
    Azure resource Id
    identity MyWorkbookManagedIdentityArgs
    Identity used for BYOS
    kind str | Kind
    The kind of workbook. Choices are user and shared.
    location str
    Resource location
    name str
    Azure resource name
    resource_name str
    The name of the Application Insights component resource.
    source_id str
    Optional resourceId for a source resource.
    storage_uri str
    BYOS Storage Account URI
    tags Mapping[str, str]
    Resource tags
    type str
    Azure resource type
    version str
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.
    category String
    Workbook category, as defined by the user at creation time.
    displayName String
    The user-defined name of the private workbook.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serializedData String
    Configuration of this particular private workbook. Configuration data is a string containing valid JSON
    id String
    Azure resource Id
    identity Property Map
    Identity used for BYOS
    kind String | "LogAlert" | "LogToMetric"
    The kind of workbook. Choices are user and shared.
    location String
    Resource location
    name String
    Azure resource name
    resourceName String
    The name of the Application Insights component resource.
    sourceId String
    Optional resourceId for a source resource.
    storageUri String
    BYOS Storage Account URI
    tags Map<String>
    Resource tags
    type String
    Azure resource type
    version String
    This instance's version of the data model. This can change as new features are added that can be marked private workbook.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData Pulumi.AzureNative.Insights.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    TimeModified string
    Date and time in UTC of the last modification that was made to this private workbook definition.
    UserId string
    Unique user id of the specific user that owns this private workbook.
    Etag Dictionary<string, string>
    Resource etag
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    TimeModified string
    Date and time in UTC of the last modification that was made to this private workbook definition.
    UserId string
    Unique user id of the specific user that owns this private workbook.
    Etag map[string]string
    Resource etag
    id String
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    timeModified String
    Date and time in UTC of the last modification that was made to this private workbook definition.
    userId String
    Unique user id of the specific user that owns this private workbook.
    etag Map<String,String>
    Resource etag
    id string
    The provider-assigned unique ID for this managed resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    timeModified string
    Date and time in UTC of the last modification that was made to this private workbook definition.
    userId string
    Unique user id of the specific user that owns this private workbook.
    etag {[key: string]: string}
    Resource etag
    id str
    The provider-assigned unique ID for this managed resource.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    time_modified str
    Date and time in UTC of the last modification that was made to this private workbook definition.
    user_id str
    Unique user id of the specific user that owns this private workbook.
    etag Mapping[str, str]
    Resource etag
    id String
    The provider-assigned unique ID for this managed resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    timeModified String
    Date and time in UTC of the last modification that was made to this private workbook definition.
    userId String
    Unique user id of the specific user that owns this private workbook.
    etag Map<String>
    Resource etag

    Supporting Types

    Kind, KindArgs

    LogAlert
    LogAlert
    LogToMetric
    LogToMetric
    KindLogAlert
    LogAlert
    KindLogToMetric
    LogToMetric
    LogAlert
    LogAlert
    LogToMetric
    LogToMetric
    LogAlert
    LogAlert
    LogToMetric
    LogToMetric
    LOG_ALERT
    LogAlert
    LOG_TO_METRIC
    LogToMetric
    "LogAlert"
    LogAlert
    "LogToMetric"
    LogToMetric

    MyWorkbookManagedIdentity, MyWorkbookManagedIdentityArgs

    Type string
    The identity type.
    Type string
    The identity type.
    type String
    The identity type.
    type string
    The identity type.
    type str
    The identity type.
    type String
    The identity type.

    MyWorkbookManagedIdentityResponse, MyWorkbookManagedIdentityResponseArgs

    Type string
    The identity type.
    UserAssignedIdentities MyWorkbookUserAssignedIdentitiesResponse
    Customer Managed Identity
    type String
    The identity type.
    userAssignedIdentities MyWorkbookUserAssignedIdentitiesResponse
    Customer Managed Identity
    type string
    The identity type.
    userAssignedIdentities MyWorkbookUserAssignedIdentitiesResponse
    Customer Managed Identity
    type str
    The identity type.
    user_assigned_identities MyWorkbookUserAssignedIdentitiesResponse
    Customer Managed Identity
    type String
    The identity type.
    userAssignedIdentities Property Map
    Customer Managed Identity

    MyWorkbookUserAssignedIdentitiesResponse, MyWorkbookUserAssignedIdentitiesResponseArgs

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.
    principalId string
    The principal ID of resource identity.
    tenantId string
    The tenant ID of resource.
    principal_id str
    The principal ID of resource identity.
    tenant_id str
    The tenant ID of resource.
    principalId String
    The principal ID of resource identity.
    tenantId String
    The tenant ID of resource.

    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.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.51.0 published on Tuesday, Jul 23, 2024 by Pulumi