Azure Native v2.9.0, Sep 27 23

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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getWorkbook

Explore with Pulumi AI

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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

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(can_fetch_content: Optional[bool] = None,
                 resource_group_name: Optional[str] = None,
                 resource_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetWorkbookResult
def get_workbook_output(can_fetch_content: Optional[pulumi.Input[bool]] = None,
                 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 resource.
CanFetchContent bool: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ResourceName string: The name of the resource.
CanFetchContent bool: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the resource.
canFetchContent Boolean: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

resourceGroupName string: The name of the resource group. The name is case insensitive.
resourceName string: The name of the resource.
canFetchContent boolean: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

resource_group_name str: The name of the resource group. The name is case insensitive.
resource_name str: The name of the resource.
can_fetch_content bool: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the resource.
canFetchContent Boolean: Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

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.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Revision string: The unique revision id for this workbook definition
SerializedData string: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UserId string: Unique user id of the specific user that owns this workbook.
Description string: The description of the workbook.
Etag string: Resource etag
Identity Pulumi.AzureNative.Insights.Outputs.WorkbookResourceResponseIdentity: Identity used for BYOS
Kind string: The kind of workbook. Only valid value is shared.
SourceId string: ResourceId for a source resource.
StorageUri string: The resourceId to the storage account when bring your own storage is used
Tags Dictionary<string, string>: Resource tags.
Version string: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

Category string: Workbook category, as defined by the user at creation time.
DisplayName string: The user-defined name (display name) of the workbook.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string: The geo-location where the resource lives
Name string: The name of the resource
Revision string: The unique revision id for this workbook definition
SerializedData string: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UserId string: Unique user id of the specific user that owns this workbook.
Description string: The description of the workbook.
Etag string: Resource etag
Identity WorkbookResourceResponseIdentity: Identity used for BYOS
Kind string: The kind of workbook. Only valid value is shared.
SourceId string: ResourceId for a source resource.
StorageUri string: The resourceId to the storage account when bring your own storage is used
Tags map[string]string: Resource tags.
Version string: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

category String: Workbook category, as defined by the user at creation time.
displayName String: The user-defined name (display name) of the workbook.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
revision String: The unique revision id for this workbook definition
serializedData String: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId String: Unique user id of the specific user that owns this workbook.
description String: The description of the workbook.
etag String: Resource etag
identity WorkbookResourceResponseIdentity: Identity used for BYOS
kind String: The kind of workbook. Only valid value is shared.
sourceId String: ResourceId for a source resource.
storageUri String: The resourceId to the storage account when bring your own storage is used
tags Map<String,String>: Resource tags.
version String: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

category string: Workbook category, as defined by the user at creation time.
displayName string: The user-defined name (display name) of the workbook.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string: The geo-location where the resource lives
name string: The name of the resource
revision string: The unique revision id for this workbook definition
serializedData string: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId string: Unique user id of the specific user that owns this workbook.
description string: The description of the workbook.
etag string: Resource etag
identity WorkbookResourceResponseIdentity: Identity used for BYOS
kind string: The kind of workbook. Only valid value is shared.
sourceId string: ResourceId for a source resource.
storageUri string: The resourceId to the storage account when bring your own storage is used
tags {[key: string]: string}: Resource tags.
version string: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

category str: Workbook category, as defined by the user at creation time.
display_name str: The user-defined name (display name) of the workbook.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str: The geo-location where the resource lives
name str: The name of the resource
revision str: The unique revision id for this workbook definition
serialized_data str: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
user_id str: Unique user id of the specific user that owns this workbook.
description str: The description of the workbook.
etag str: Resource etag
identity WorkbookResourceResponseIdentity: Identity used for BYOS
kind str: The kind of workbook. Only valid value is shared.
source_id str: ResourceId for a source resource.
storage_uri str: The resourceId to the storage account when bring your own storage is used
tags Mapping[str, str]: Resource tags.
version str: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

category String: Workbook category, as defined by the user at creation time.
displayName String: The user-defined name (display name) of the workbook.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String: The geo-location where the resource lives
name String: The name of the resource
revision String: The unique revision id for this workbook definition
serializedData String: Configuration of this particular workbook. Configuration data is a string containing valid JSON
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 workbook definition.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId String: Unique user id of the specific user that owns this workbook.
description String: The description of the workbook.
etag String: Resource etag
identity Property Map: Identity used for BYOS
kind String: The kind of workbook. Only valid value is shared.
sourceId String: ResourceId for a source resource.
storageUri String: The resourceId to the storage account when bring your own storage is used
tags Map<String>: Resource tags.
version String: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

Supporting Types

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.

UserAssignedIdentityResponse

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

ClientId string: The client ID of the assigned identity.
PrincipalId string: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

clientId string: The client ID of the assigned identity.
principalId string: The principal ID of the assigned identity.

client_id str: The client ID of the assigned identity.
principal_id str: The principal ID of the assigned identity.

clientId String: The client ID of the assigned identity.
principalId String: The principal ID of the assigned identity.

WorkbookResourceResponseIdentity

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Insights.Inputs.UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrincipalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId string: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId string: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type string: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principal_id str: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id str: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type str: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

principalId String: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId String: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type String: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getWorkbook

On this page

On this page

Using getWorkbook

getWorkbook Result

Supporting Types

SystemDataResponse

UserAssignedIdentityResponse

WorkbookResourceResponseIdentity

Package Details

On this page

On this page