insights.azure.com/v1api20210501preview

Package v1api20210501preview contains API Schema definitions for the insights v1api20210501preview API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-05-01-preview"

DiagnosticSetting

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json - ARM URI: /{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
DiagnosticSetting_Spec

`azureName` string	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.
`eventHubAuthorizationRuleReference` genruntime.ResourceReference	EventHubAuthorizationRuleReference: The resource Id for the event hub authorization rule.
`eventHubName` string	EventHubName: The name of the event hub. If none is specified, the default event hub will be selected.
`logAnalyticsDestinationType` string	LogAnalyticsDestinationType: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
`logs` []LogSettings	Logs: The list of logs settings.
`marketplacePartnerReference` genruntime.ResourceReference	MarketplacePartnerReference: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
`metrics` []MetricSettings	Metrics: The list of metric settings.
`operatorSpec` DiagnosticSettingOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	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. This resource is an extension resource, which means that any other Azure resource can be its owner.
`serviceBusRuleId` string	ServiceBusRuleId: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
`storageAccountReference` genruntime.ResourceReference	StorageAccountReference: The resource ID of the storage account to which you would like to send Diagnostic Logs.
`workspaceReference` genruntime.ResourceReference	WorkspaceReference: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

status
DiagnosticSetting_STATUS

DiagnosticSettingOperatorSpec

(Appears on:DiagnosticSetting_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

DiagnosticSetting_STATUS

(Appears on:DiagnosticSetting)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`eventHubAuthorizationRuleId` string	EventHubAuthorizationRuleId: The resource Id for the event hub authorization rule.
`eventHubName` string	EventHubName: The name of the event hub. If none is specified, the default event hub will be selected.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`logAnalyticsDestinationType` string	LogAnalyticsDestinationType: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
`logs` []LogSettings_STATUS	Logs: The list of logs settings.
`marketplacePartnerId` string	MarketplacePartnerId: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
`metrics` []MetricSettings_STATUS	Metrics: The list of metric settings.
`name` string	Name: The name of the resource
`serviceBusRuleId` string	ServiceBusRuleId: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
`storageAccountId` string	StorageAccountId: The resource ID of the storage account to which you would like to send Diagnostic Logs.
`systemData` SystemData_STATUS	SystemData: The system metadata related to this resource.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`workspaceId` string	WorkspaceId: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

DiagnosticSetting_Spec

(Appears on:DiagnosticSetting)

Field	Description
`azureName` string	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.
`eventHubAuthorizationRuleReference` genruntime.ResourceReference	EventHubAuthorizationRuleReference: The resource Id for the event hub authorization rule.
`eventHubName` string	EventHubName: The name of the event hub. If none is specified, the default event hub will be selected.
`logAnalyticsDestinationType` string	LogAnalyticsDestinationType: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
`logs` []LogSettings	Logs: The list of logs settings.
`marketplacePartnerReference` genruntime.ResourceReference	MarketplacePartnerReference: The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
`metrics` []MetricSettings	Metrics: The list of metric settings.
`operatorSpec` DiagnosticSettingOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.ArbitraryOwnerReference	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. This resource is an extension resource, which means that any other Azure resource can be its owner.
`serviceBusRuleId` string	ServiceBusRuleId: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
`storageAccountReference` genruntime.ResourceReference	StorageAccountReference: The resource ID of the storage account to which you would like to send Diagnostic Logs.
`workspaceReference` genruntime.ResourceReference	WorkspaceReference: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

LogSettings

(Appears on:DiagnosticSetting_Spec)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

Field	Description
`category` string	Category: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
`categoryGroup` string	CategoryGroup: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
`enabled` bool	Enabled: a value indicating whether this log is enabled.
`retentionPolicy` RetentionPolicy	RetentionPolicy: the retention policy for this log.

LogSettings_STATUS

(Appears on:DiagnosticSetting_STATUS)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

Field	Description
`category` string	Category: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
`categoryGroup` string	CategoryGroup: Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
`enabled` bool	Enabled: a value indicating whether this log is enabled.
`retentionPolicy` RetentionPolicy_STATUS	RetentionPolicy: the retention policy for this log.

MetricSettings

(Appears on:DiagnosticSetting_Spec)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

Field	Description
`category` string	Category: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
`enabled` bool	Enabled: a value indicating whether this category is enabled.
`retentionPolicy` RetentionPolicy	RetentionPolicy: the retention policy for this category.
`timeGrain` string	TimeGrain: the timegrain of the metric in ISO8601 format.

MetricSettings_STATUS

(Appears on:DiagnosticSetting_STATUS)

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

Field	Description
`category` string	Category: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
`enabled` bool	Enabled: a value indicating whether this category is enabled.
`retentionPolicy` RetentionPolicy_STATUS	RetentionPolicy: the retention policy for this category.
`timeGrain` string	TimeGrain: the timegrain of the metric in ISO8601 format.

RetentionPolicy

(Appears on:LogSettings, MetricSettings)

Specifies the retention policy for the log.

Field	Description
`days` int	Days: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
`enabled` bool	Enabled: a value indicating whether the retention policy is enabled.

RetentionPolicy_STATUS

(Appears on:LogSettings_STATUS, MetricSettings_STATUS)

Specifies the retention policy for the log.

Field	Description
`days` int	Days: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
`enabled` bool	Enabled: a value indicating whether the retention policy is enabled.

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:DiagnosticSetting_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

insights.azure.com/v1api20210501preview