insights.azure.com/v1api20230601
APIVersion
| Value | Description |
|---|---|
| “2023-06-01” |
Workbook
Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/stable/2023-06-01/workbooks_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
Used by: WorkbookList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Workbook_Spec Optional |
|
| status | Workbook_STATUS Optional |
Workbook_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| category | Workbook category, as defined by the user at creation time. | string Required |
| description | The description of the workbook. | string Optional |
| displayName | The user-defined name (display name) of the workbook. | string Required |
| identity | Identity used for BYOS | ManagedServiceIdentity Optional |
| kind | The kind of workbook. Only valid value is shared. | Workbook_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkbookOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties_tags | Being deprecated, please use the other tags field | string[] Optional |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string Required |
| sourceReference | ResourceId for a source resource. | genruntime.ResourceReference Optional |
| storageUriReference | The resourceId to the storage account when bring your own storage is used | genruntime.ResourceReference Optional |
| tags | Resource tags. | map[string]string Optional |
| version | Workbook schema version format, like ‘Notebook/1.0’, which should match the workbook in serializedData | string Optional |
Workbook_STATUS
| Property | Description | Type |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | The description of the workbook. | string Optional |
| displayName | The user-defined name (display name) of the workbook. | string Optional |
| etag | Resource etag | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity used for BYOS | ManagedServiceIdentity_STATUS Optional |
| kind | The kind of workbook. Only valid value is shared. | Workbook_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties_tags | Being deprecated, please use the other tags field | string[] Optional |
| revision | The unique revision id for this workbook definition | string Optional |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string Optional |
| sourceId | ResourceId for a source resource. | string Optional |
| storageUri | The resourceId to the storage account when bring your own storage is used | string Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| timeModified | Date and time in UTC of the last modification that was made to this workbook definition. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| userId | Unique user id of the specific user that owns this workbook. | string Optional |
| version | Workbook schema version format, like ‘Notebook/1.0’, which should match the workbook in serializedData | string Optional |
WorkbookList
Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/stable/2023-06-01/workbooks_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Workbook[] Optional |
Workbook_Spec
Used by: Workbook.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| category | Workbook category, as defined by the user at creation time. | string Required |
| description | The description of the workbook. | string Optional |
| displayName | The user-defined name (display name) of the workbook. | string Required |
| identity | Identity used for BYOS | ManagedServiceIdentity Optional |
| kind | The kind of workbook. Only valid value is shared. | Workbook_Kind_Spec Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkbookOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties_tags | Being deprecated, please use the other tags field | string[] Optional |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string Required |
| sourceReference | ResourceId for a source resource. | genruntime.ResourceReference Optional |
| storageUriReference | The resourceId to the storage account when bring your own storage is used | genruntime.ResourceReference Optional |
| tags | Resource tags. | map[string]string Optional |
| version | Workbook schema version format, like ‘Notebook/1.0’, which should match the workbook in serializedData | string Optional |
Workbook_STATUS
A workbook definition.
Used by: Workbook.
| Property | Description | Type |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | The description of the workbook. | string Optional |
| displayName | The user-defined name (display name) of the workbook. | string Optional |
| etag | Resource etag | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity used for BYOS | ManagedServiceIdentity_STATUS Optional |
| kind | The kind of workbook. Only valid value is shared. | Workbook_Kind_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| properties_tags | Being deprecated, please use the other tags field | string[] Optional |
| revision | The unique revision id for this workbook definition | string Optional |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string Optional |
| sourceId | ResourceId for a source resource. | string Optional |
| storageUri | The resourceId to the storage account when bring your own storage is used | string Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| timeModified | Date and time in UTC of the last modification that was made to this workbook definition. | string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| userId | Unique user id of the specific user that owns this workbook. | string Optional |
| version | Workbook schema version format, like ‘Notebook/1.0’, which should match the workbook in serializedData | string Optional |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: Workbook_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: Workbook_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | map[string]UserAssignedIdentity_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: Workbook_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
Workbook_Kind_Spec
Used by: Workbook_Spec.
| Value | Description |
|---|---|
| “shared” |
Workbook_Kind_STATUS
Used by: Workbook_STATUS.
| Value | Description |
|---|---|
| “shared” |
WorkbookOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Workbook_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |