insights.azure.com/v1api20230101

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

Resource Types:

APIVersion (`string` alias)

Value	Description
"2023-01-01"

ActionGroup

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-01-01/actionGroups_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}

Field Description

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

spec
ActionGroup_Spec

`armRoleReceivers` []ArmRoleReceiver	ArmRoleReceivers: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
`automationRunbookReceivers` []AutomationRunbookReceiver	AutomationRunbookReceivers: The list of AutomationRunbook receivers that are part of this action group.
`azureAppPushReceivers` []AzureAppPushReceiver	AzureAppPushReceivers: The list of AzureAppPush receivers that are part of this action group.
`azureFunctionReceivers` []AzureFunctionReceiver	AzureFunctionReceivers: The list of azure function receivers that are part of this action group.
`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.
`emailReceivers` []EmailReceiver	EmailReceivers: The list of email receivers that are part of this action group.
`enabled` bool	Enabled: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
`eventHubReceivers` []EventHubReceiver	EventHubReceivers: The list of event hub receivers that are part of this action group.
`groupShortName` string	GroupShortName: The short name of the action group. This will be used in SMS messages.
`itsmReceivers` []ItsmReceiver	ItsmReceivers: The list of ITSM receivers that are part of this action group.
`location` string	Location: Resource location
`logicAppReceivers` []LogicAppReceiver	LogicAppReceivers: The list of logic app receivers that are part of this action group.
`operatorSpec` ActionGroupOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`smsReceivers` []SmsReceiver	SmsReceivers: The list of SMS receivers that are part of this action group.
`tags` map[string]string	Tags: Resource tags
`voiceReceivers` []VoiceReceiver	VoiceReceivers: The list of voice receivers that are part of this action group.
`webhookReceivers` []WebhookReceiver	WebhookReceivers: The list of webhook receivers that are part of this action group.

status
ActionGroupResource_STATUS

ActionGroupOperatorSpec

(Appears on:ActionGroup_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).

ActionGroupResource_STATUS

(Appears on:ActionGroup)

An action group resource.

Field	Description
`armRoleReceivers` []ArmRoleReceiver_STATUS	ArmRoleReceivers: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
`automationRunbookReceivers` []AutomationRunbookReceiver_STATUS	AutomationRunbookReceivers: The list of AutomationRunbook receivers that are part of this action group.
`azureAppPushReceivers` []AzureAppPushReceiver_STATUS	AzureAppPushReceivers: The list of AzureAppPush receivers that are part of this action group.
`azureFunctionReceivers` []AzureFunctionReceiver_STATUS	AzureFunctionReceivers: The list of azure function receivers that are part of this action group.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`emailReceivers` []EmailReceiver_STATUS	EmailReceivers: The list of email receivers that are part of this action group.
`enabled` bool	Enabled: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
`eventHubReceivers` []EventHubReceiver_STATUS	EventHubReceivers: The list of event hub receivers that are part of this action group.
`groupShortName` string	GroupShortName: The short name of the action group. This will be used in SMS messages.
`id` string	Id: Azure resource Id
`itsmReceivers` []ItsmReceiver_STATUS	ItsmReceivers: The list of ITSM receivers that are part of this action group.
`location` string	Location: Resource location
`logicAppReceivers` []LogicAppReceiver_STATUS	LogicAppReceivers: The list of logic app receivers that are part of this action group.
`name` string	Name: Azure resource name
`smsReceivers` []SmsReceiver_STATUS	SmsReceivers: The list of SMS receivers that are part of this action group.
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Azure resource type
`voiceReceivers` []VoiceReceiver_STATUS	VoiceReceivers: The list of voice receivers that are part of this action group.
`webhookReceivers` []WebhookReceiver_STATUS	WebhookReceivers: The list of webhook receivers that are part of this action group.

ActionGroup_Spec

(Appears on:ActionGroup)

Field	Description
`armRoleReceivers` []ArmRoleReceiver	ArmRoleReceivers: The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported.
`automationRunbookReceivers` []AutomationRunbookReceiver	AutomationRunbookReceivers: The list of AutomationRunbook receivers that are part of this action group.
`azureAppPushReceivers` []AzureAppPushReceiver	AzureAppPushReceivers: The list of AzureAppPush receivers that are part of this action group.
`azureFunctionReceivers` []AzureFunctionReceiver	AzureFunctionReceivers: The list of azure function receivers that are part of this action group.
`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.
`emailReceivers` []EmailReceiver	EmailReceivers: The list of email receivers that are part of this action group.
`enabled` bool	Enabled: Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications.
`eventHubReceivers` []EventHubReceiver	EventHubReceivers: The list of event hub receivers that are part of this action group.
`groupShortName` string	GroupShortName: The short name of the action group. This will be used in SMS messages.
`itsmReceivers` []ItsmReceiver	ItsmReceivers: The list of ITSM receivers that are part of this action group.
`location` string	Location: Resource location
`logicAppReceivers` []LogicAppReceiver	LogicAppReceivers: The list of logic app receivers that are part of this action group.
`operatorSpec` ActionGroupOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	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
`smsReceivers` []SmsReceiver	SmsReceivers: The list of SMS receivers that are part of this action group.
`tags` map[string]string	Tags: Resource tags
`voiceReceivers` []VoiceReceiver	VoiceReceivers: The list of voice receivers that are part of this action group.
`webhookReceivers` []WebhookReceiver	WebhookReceivers: The list of webhook receivers that are part of this action group.

ArmRoleReceiver

(Appears on:ActionGroup_Spec)

An arm role receiver.

Field	Description
`name` string	Name: The name of the arm role receiver. Names must be unique across all receivers within an action group.
`roleId` string	RoleId: The arm role id.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

ArmRoleReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An arm role receiver.

Field	Description
`name` string	Name: The name of the arm role receiver. Names must be unique across all receivers within an action group.
`roleId` string	RoleId: The arm role id.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

AutomationRunbookReceiver

(Appears on:ActionGroup_Spec)

The Azure Automation Runbook notification receiver.

Field	Description
`automationAccountId` string	AutomationAccountId: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
`isGlobalRunbook` bool	IsGlobalRunbook: Indicates whether this instance is global runbook.
`name` string	Name: Indicates name of the webhook.
`runbookName` string	RunbookName: The name for this runbook.
`serviceUri` string	ServiceUri: The URI where webhooks should be sent.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.
`webhookResourceReference` genruntime.ResourceReference	WebhookResourceReference: The resource id for webhook linked to this runbook.

AutomationRunbookReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

The Azure Automation Runbook notification receiver.

Field	Description
`automationAccountId` string	AutomationAccountId: The Azure automation account Id which holds this runbook and authenticate to Azure resource.
`isGlobalRunbook` bool	IsGlobalRunbook: Indicates whether this instance is global runbook.
`name` string	Name: Indicates name of the webhook.
`runbookName` string	RunbookName: The name for this runbook.
`serviceUri` string	ServiceUri: The URI where webhooks should be sent.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.
`webhookResourceId` string	WebhookResourceId: The resource id for webhook linked to this runbook.

AzureAppPushReceiver

(Appears on:ActionGroup_Spec)

The Azure mobile App push notification receiver.

Field	Description
`emailAddress` string	EmailAddress: The email address registered for the Azure mobile app.
`name` string	Name: The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.

AzureAppPushReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

The Azure mobile App push notification receiver.

Field	Description
`emailAddress` string	EmailAddress: The email address registered for the Azure mobile app.
`name` string	Name: The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group.

AzureFunctionReceiver

(Appears on:ActionGroup_Spec)

An azure function receiver.

Field	Description
`functionAppResourceReference` genruntime.ResourceReference	FunctionAppResourceReference: The azure resource id of the function app.
`functionName` string	FunctionName: The function name in the function app.
`httpTriggerUrl` string	HttpTriggerUrl: The http trigger url where http request sent to.
`name` string	Name: The name of the azure function receiver. Names must be unique across all receivers within an action group.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

AzureFunctionReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An azure function receiver.

Field	Description
`functionAppResourceId` string	FunctionAppResourceId: The azure resource id of the function app.
`functionName` string	FunctionName: The function name in the function app.
`httpTriggerUrl` string	HttpTriggerUrl: The http trigger url where http request sent to.
`name` string	Name: The name of the azure function receiver. Names must be unique across all receivers within an action group.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

EmailReceiver

(Appears on:ActionGroup_Spec)

An email receiver.

Field	Description
`emailAddress` string	EmailAddress: The email address of this receiver.
`name` string	Name: The name of the email receiver. Names must be unique across all receivers within an action group.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

EmailReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An email receiver.

Field	Description
`emailAddress` string	EmailAddress: The email address of this receiver.
`name` string	Name: The name of the email receiver. Names must be unique across all receivers within an action group.
`status` ReceiverStatus_STATUS	Status: The receiver status of the e-mail.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

EventHubReceiver

(Appears on:ActionGroup_Spec)

An Event hub receiver.

Field	Description
`eventHubName` string	EventHubName: The name of the specific Event Hub queue
`eventHubNameSpace` string	EventHubNameSpace: The Event Hub namespace
`name` string	Name: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
`subscriptionId` string	SubscriptionId: The Id for the subscription containing this event hub
`tenantId` string	TenantId: The tenant Id for the subscription containing this event hub
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

EventHubReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An Event hub receiver.

Field	Description
`eventHubName` string	EventHubName: The name of the specific Event Hub queue
`eventHubNameSpace` string	EventHubNameSpace: The Event Hub namespace
`name` string	Name: The name of the Event hub receiver. Names must be unique across all receivers within an action group.
`subscriptionId` string	SubscriptionId: The Id for the subscription containing this event hub
`tenantId` string	TenantId: The tenant Id for the subscription containing this event hub
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

ItsmReceiver

(Appears on:ActionGroup_Spec)

An Itsm receiver.

Field	Description
`connectionId` string	ConnectionId: Unique identification of ITSM connection among multiple defined in above workspace.
`name` string	Name: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
`region` string	Region: Region in which workspace resides. Supported values:‘centralindia’,‘japaneast’,‘southeastasia’,‘australiasoutheast’,‘uksouth’,‘westcentralus’,‘canadacentral’,‘eastus’,‘westeurope’
`ticketConfiguration` string	TicketConfiguration: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
`workspaceId` string	WorkspaceId: OMS LA instance identifier.

ItsmReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An Itsm receiver.

Field	Description
`connectionId` string	ConnectionId: Unique identification of ITSM connection among multiple defined in above workspace.
`name` string	Name: The name of the Itsm receiver. Names must be unique across all receivers within an action group.
`region` string	Region: Region in which workspace resides. Supported values:‘centralindia’,‘japaneast’,‘southeastasia’,‘australiasoutheast’,‘uksouth’,‘westcentralus’,‘canadacentral’,‘eastus’,‘westeurope’
`ticketConfiguration` string	TicketConfiguration: JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.
`workspaceId` string	WorkspaceId: OMS LA instance identifier.

LogicAppReceiver

(Appears on:ActionGroup_Spec)

A logic app receiver.

Field	Description
`callbackUrl` string	CallbackUrl: The callback url where http request sent to.
`name` string	Name: The name of the logic app receiver. Names must be unique across all receivers within an action group.
`resourceReference` genruntime.ResourceReference	ResourceReference: The azure resource id of the logic app receiver.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

LogicAppReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

A logic app receiver.

Field	Description
`callbackUrl` string	CallbackUrl: The callback url where http request sent to.
`name` string	Name: The name of the logic app receiver. Names must be unique across all receivers within an action group.
`resourceId` string	ResourceId: The azure resource id of the logic app receiver.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

ReceiverStatus_STATUS (`string` alias)

(Appears on:EmailReceiver_STATUS, SmsReceiver_STATUS)

Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications.

Value	Description
"Disabled"
"Enabled"
"NotSpecified"

SmsReceiver

(Appears on:ActionGroup_Spec)

An SMS receiver.

Field	Description
`countryCode` string	CountryCode: The country code of the SMS receiver.
`name` string	Name: The name of the SMS receiver. Names must be unique across all receivers within an action group.
`phoneNumber` string	PhoneNumber: The phone number of the SMS receiver.

SmsReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

An SMS receiver.

Field	Description
`countryCode` string	CountryCode: The country code of the SMS receiver.
`name` string	Name: The name of the SMS receiver. Names must be unique across all receivers within an action group.
`phoneNumber` string	PhoneNumber: The phone number of the SMS receiver.
`status` ReceiverStatus_STATUS	Status: The status of the receiver.

VoiceReceiver

(Appears on:ActionGroup_Spec)

A voice receiver.

Field	Description
`countryCode` string	CountryCode: The country code of the voice receiver.
`name` string	Name: The name of the voice receiver. Names must be unique across all receivers within an action group.
`phoneNumber` string	PhoneNumber: The phone number of the voice receiver.

VoiceReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

A voice receiver.

Field	Description
`countryCode` string	CountryCode: The country code of the voice receiver.
`name` string	Name: The name of the voice receiver. Names must be unique across all receivers within an action group.
`phoneNumber` string	PhoneNumber: The phone number of the voice receiver.

WebhookReceiver

(Appears on:ActionGroup_Spec)

A webhook receiver.

Field	Description
`identifierUri` string	IdentifierUri: Indicates the identifier uri for aad auth.
`name` string	Name: The name of the webhook receiver. Names must be unique across all receivers within an action group.
`objectId` string	ObjectId: Indicates the webhook app object Id for aad auth.
`serviceUri` string	ServiceUri: The URI where webhooks should be sent.
`tenantId` string	TenantId: Indicates the tenant id for aad auth.
`useAadAuth` bool	UseAadAuth: Indicates whether or not use AAD authentication.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

WebhookReceiver_STATUS

(Appears on:ActionGroupResource_STATUS)

A webhook receiver.

Field	Description
`identifierUri` string	IdentifierUri: Indicates the identifier uri for aad auth.
`name` string	Name: The name of the webhook receiver. Names must be unique across all receivers within an action group.
`objectId` string	ObjectId: Indicates the webhook app object Id for aad auth.
`serviceUri` string	ServiceUri: The URI where webhooks should be sent.
`tenantId` string	TenantId: Indicates the tenant id for aad auth.
`useAadAuth` bool	UseAadAuth: Indicates whether or not use AAD authentication.
`useCommonAlertSchema` bool	UseCommonAlertSchema: Indicates whether to use common alert schema.

insights.azure.com/v1api20230101