1. Packages
  2. Azure Native v1
  3. API Docs
  4. insights
  5. getWorkbook
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.insights.getWorkbook

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

    Get a single workbook by its resourceName. API Version: 2020-10-20.

    Using getWorkbook

    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 getWorkbook(args: GetWorkbookArgs, opts?: InvokeOptions): Promise<GetWorkbookResult>
    function getWorkbookOutput(args: GetWorkbookOutputArgs, opts?: InvokeOptions): Output<GetWorkbookResult>
    def get_workbook(resource_group_name: Optional[str] = None,
                     resource_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWorkbookResult
    def get_workbook_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     resource_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetWorkbookResult]
    func LookupWorkbook(ctx *Context, args *LookupWorkbookArgs, opts ...InvokeOption) (*LookupWorkbookResult, error)
    func LookupWorkbookOutput(ctx *Context, args *LookupWorkbookOutputArgs, opts ...InvokeOption) LookupWorkbookResultOutput

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

    public static class GetWorkbook 
    {
        public static Task<GetWorkbookResult> InvokeAsync(GetWorkbookArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkbookResult> Invoke(GetWorkbookInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWorkbookResult> getWorkbook(GetWorkbookArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:insights:getWorkbook
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Application Insights component resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the Application Insights component resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Application Insights component resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the Application Insights component resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the Application Insights component resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the Application Insights component resource.

    getWorkbook Result

    The following output properties are available:

    Category string
    Workbook category, as defined by the user at creation time.
    DisplayName string
    The user-defined name (display name) of the workbook.
    SerializedData string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    TimeModified string
    Date and time in UTC of the last modification that was made to this workbook definition.
    UserId string
    Unique user id of the specific user that owns this workbook.
    Etag Dictionary<string, string>
    Resource etag
    Id string
    Azure resource Id
    Identity Pulumi.AzureNative.Insights.Outputs.WorkbookManagedIdentityResponse
    Identity used for BYOS
    Kind string
    The kind of workbook. Choices are user and shared.
    Location string
    Resource location
    Name string
    Azure resource name
    SourceId string
    ResourceId for a source resource.
    StorageUri string
    BYOS Storage Account URI
    Tags Dictionary<string, string>
    Resource tags
    Type string
    Azure resource type
    Version string
    Workbook version
    Category string
    Workbook category, as defined by the user at creation time.
    DisplayName string
    The user-defined name (display name) of the workbook.
    SerializedData string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    TimeModified string
    Date and time in UTC of the last modification that was made to this workbook definition.
    UserId string
    Unique user id of the specific user that owns this workbook.
    Etag map[string]string
    Resource etag
    Id string
    Azure resource Id
    Identity WorkbookManagedIdentityResponse
    Identity used for BYOS
    Kind string
    The kind of workbook. Choices are user and shared.
    Location string
    Resource location
    Name string
    Azure resource name
    SourceId string
    ResourceId for a source resource.
    StorageUri string
    BYOS Storage Account URI
    Tags map[string]string
    Resource tags
    Type string
    Azure resource type
    Version string
    Workbook version
    category String
    Workbook category, as defined by the user at creation time.
    displayName String
    The user-defined name (display name) of the workbook.
    serializedData String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    timeModified String
    Date and time in UTC of the last modification that was made to this workbook definition.
    userId String
    Unique user id of the specific user that owns this workbook.
    etag Map<String,String>
    Resource etag
    id String
    Azure resource Id
    identity WorkbookManagedIdentityResponse
    Identity used for BYOS
    kind String
    The kind of workbook. Choices are user and shared.
    location String
    Resource location
    name String
    Azure resource name
    sourceId String
    ResourceId for a source resource.
    storageUri String
    BYOS Storage Account URI
    tags Map<String,String>
    Resource tags
    type String
    Azure resource type
    version String
    Workbook version
    category string
    Workbook category, as defined by the user at creation time.
    displayName string
    The user-defined name (display name) of the workbook.
    serializedData string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    timeModified string
    Date and time in UTC of the last modification that was made to this workbook definition.
    userId string
    Unique user id of the specific user that owns this workbook.
    etag {[key: string]: string}
    Resource etag
    id string
    Azure resource Id
    identity WorkbookManagedIdentityResponse
    Identity used for BYOS
    kind string
    The kind of workbook. Choices are user and shared.
    location string
    Resource location
    name string
    Azure resource name
    sourceId string
    ResourceId for a source resource.
    storageUri string
    BYOS Storage Account URI
    tags {[key: string]: string}
    Resource tags
    type string
    Azure resource type
    version string
    Workbook version
    category str
    Workbook category, as defined by the user at creation time.
    display_name str
    The user-defined name (display name) of the workbook.
    serialized_data str
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    time_modified str
    Date and time in UTC of the last modification that was made to this workbook definition.
    user_id str
    Unique user id of the specific user that owns this workbook.
    etag Mapping[str, str]
    Resource etag
    id str
    Azure resource Id
    identity WorkbookManagedIdentityResponse
    Identity used for BYOS
    kind str
    The kind of workbook. Choices are user and shared.
    location str
    Resource location
    name str
    Azure resource name
    source_id str
    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
    Workbook version
    category String
    Workbook category, as defined by the user at creation time.
    displayName String
    The user-defined name (display name) of the workbook.
    serializedData String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON
    timeModified String
    Date and time in UTC of the last modification that was made to this workbook definition.
    userId String
    Unique user id of the specific user that owns this workbook.
    etag Map<String>
    Resource etag
    id String
    Azure resource Id
    identity Property Map
    Identity used for BYOS
    kind String
    The kind of workbook. Choices are user and shared.
    location String
    Resource location
    name String
    Azure resource name
    sourceId String
    ResourceId for a source resource.
    storageUri String
    BYOS Storage Account URI
    tags Map<String>
    Resource tags
    type String
    Azure resource type
    version String
    Workbook version

    Supporting Types

    WorkbookManagedIdentityResponse

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

    WorkbookUserAssignedIdentitiesResponse

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

    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