Action Groups - Update
Uppdateringar en befintlig åtgärdsgrupps taggar. Om du vill uppdatera andra fält använder du metoden CreateOrUpdate.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/actionGroups/{actionGroupName}?api-version=2021-09-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
action
|
path | True |
string |
Namnet på åtgärdsgruppen. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Typ | Description |
---|---|---|
properties.enabled |
boolean |
Anger om den här åtgärdsgruppen är aktiverad. Om en åtgärdsgrupp inte är aktiverad aktiveras ingen av dess åtgärder. |
tags |
object |
Resurstaggar |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
En befintlig åtgärdsgrupp har uppdaterats. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Patch an action group
Exempelbegäran
PATCH https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/Microsoft.Insights/actionGroups/SampleActionGroup?api-version=2021-09-01
{
"tags": {
"key1": "value1",
"key2": "value2"
},
"properties": {
"enabled": false
}
}
Exempelsvar
{
"id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup",
"type": "Microsoft.Insights/ActionGroups",
"name": "SampleActionGroup",
"location": "Global",
"tags": {
"key1": "value1",
"key2": "value2"
},
"properties": {
"groupShortName": "sample",
"enabled": true,
"emailReceivers": [
{
"name": "John Doe's email",
"emailAddress": "johndoe@email.com",
"status": "Enabled",
"useCommonAlertSchema": true
},
{
"name": "Jane Smith's email",
"emailAddress": "janesmith@email.com",
"status": "Enabled",
"useCommonAlertSchema": true
}
],
"smsReceivers": [
{
"name": "John Doe's mobile",
"countryCode": "1",
"phoneNumber": "1234567890",
"status": "Enabled"
},
{
"name": "Jane Smith's mobile",
"countryCode": "1",
"phoneNumber": "0987654321",
"status": "Enabled"
}
],
"webhookReceivers": [
{
"name": "Sample webhook",
"serviceUri": "http://www.example.com/webhook",
"useCommonAlertSchema": false
},
{
"name": "Sample webhook 2",
"serviceUri": "http://www.example.com/webhook2",
"useCommonAlertSchema": true,
"useAadAuth": true,
"objectId": "d3bb868c-fe44-452c-aa26-769a6538c808",
"identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a",
"tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84"
}
],
"itsmReceivers": [],
"azureAppPushReceivers": [],
"automationRunbookReceivers": [],
"voiceReceivers": [],
"logicAppReceivers": [],
"azureFunctionReceivers": [],
"armRoleReceivers": [],
"eventHubReceivers": []
}
}
Definitioner
Name | Description |
---|---|
Action |
Ett åtgärdsgruppsobjekt för brödtexten för korrigeringsåtgärder. |
Action |
En åtgärdsgruppsresurs. |
Arm |
En armrollsmottagare. |
Automation |
Azure Automation Runbook-meddelandemottagare. |
Azure |
Push-meddelandemottagaren för Azure Mobile App. |
Azure |
En azure-funktionsmottagare. |
Email |
En e-postmottagare. |
Error |
Beskriver formatet felsvar. |
Event |
En händelsehubbmottagare. |
Itsm |
En Itsm-mottagare. |
Logic |
En logikappsmottagare. |
Receiver |
Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation. |
Sms |
En SMS-mottagare. |
Voice |
En röstmottagare. |
Webhook |
En webhook-mottagare. |
ActionGroupPatchBody
Ett åtgärdsgruppsobjekt för brödtexten för korrigeringsåtgärder.
Name | Typ | Standardvärde | Description |
---|---|---|---|
properties.enabled |
boolean |
True |
Anger om den här åtgärdsgruppen är aktiverad. Om en åtgärdsgrupp inte är aktiverad aktiveras ingen av dess åtgärder. |
tags |
object |
Resurstaggar |
ActionGroupResource
En åtgärdsgruppsresurs.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Azure-resurs-ID |
|
location |
string |
Resursplats |
|
name |
string |
Azure-resursnamn |
|
properties.armRoleReceivers |
Listan över ARM-rollmottagare som ingår i den här åtgärdsgruppen. Roller är Azure RBAC-roller och endast inbyggda roller stöds. |
||
properties.automationRunbookReceivers |
Listan över AutomationRunbook-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.azureAppPushReceivers |
Listan över AzureAppPush-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.azureFunctionReceivers |
Listan över azure-funktionsmottagare som ingår i den här åtgärdsgruppen. |
||
properties.emailReceivers |
Listan över e-postmottagare som ingår i den här åtgärdsgruppen. |
||
properties.enabled |
boolean |
True |
Anger om den här åtgärdsgruppen är aktiverad. Om en åtgärdsgrupp inte är aktiverad får ingen av dess mottagare kommunikation. |
properties.eventHubReceivers |
Listan över event hub-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.groupShortName |
string |
Åtgärdsgruppens korta namn. Detta kommer att användas i SMS. |
|
properties.itsmReceivers |
Listan över ITSM-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.logicAppReceivers |
Listan över logic app-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.smsReceivers |
Listan över SMS-mottagare som ingår i den här åtgärdsgruppen. |
||
properties.voiceReceivers |
Listan över röstmottagare som ingår i den här åtgärdsgruppen. |
||
properties.webhookReceivers |
Listan över webhook-mottagare som ingår i den här åtgärdsgruppen. |
||
tags |
object |
Resurstaggar |
|
type |
string |
Azure-resurstyp |
ArmRoleReceiver
En armrollsmottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
name |
string |
Namnet på armrollmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
roleId |
string |
Armrolls-ID: t. |
|
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
AutomationRunbookReceiver
Azure Automation Runbook-meddelandemottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
automationAccountId |
string |
Azure Automation-konto-ID:t som innehåller den här runbooken och autentiserar till Azure-resursen. |
|
isGlobalRunbook |
boolean |
Anger om den här instansen är en global runbook. |
|
name |
string |
Anger namnet på webhooken. |
|
runbookName |
string |
Namnet på den här runbooken. |
|
serviceUri |
string |
Den URI där webhooks ska skickas. |
|
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
webhookResourceId |
string |
Resurs-ID:t för webhook som är länkat till den här runbooken. |
AzureAppPushReceiver
Push-meddelandemottagaren för Azure Mobile App.
Name | Typ | Description |
---|---|---|
emailAddress |
string |
Den e-postadress som registrerats för Azure-mobilappen. |
name |
string |
Namnet på Azure-mobilappens push-mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
AzureFunctionReceiver
En azure-funktionsmottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
functionAppResourceId |
string |
Azure-resurs-ID för funktionsappen. |
|
functionName |
string |
Funktionsnamnet i funktionsappen. |
|
httpTriggerUrl |
string |
HTTP-utlösarens URL där http-begäran skickades till. |
|
name |
string |
Namnet på azure-funktionsmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
EmailReceiver
En e-postmottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
emailAddress |
string |
Mottagarens e-postadress. |
|
name |
string |
Namnet på e-postmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
status |
Mottagarens status för e-postmeddelandet. |
||
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
ErrorResponse
Beskriver formatet felsvar.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod |
message |
string |
Felmeddelande som anger varför åtgärden misslyckades. |
EventHubReceiver
En händelsehubbmottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
eventHubName |
string |
Namnet på den specifika Event Hub-kön |
|
eventHubNameSpace |
string |
Event Hub-namnområdet |
|
name |
string |
Namnet på händelsehubbens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
subscriptionId |
string |
ID:t för prenumerationen som innehåller den här händelsehubben |
|
tenantId |
string |
Klient-ID:t för prenumerationen som innehåller den här händelsehubben |
|
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
ItsmReceiver
En Itsm-mottagare.
Name | Typ | Description |
---|---|---|
connectionId |
string |
Unik identifiering av ITSM-anslutning mellan flera som definierats i ovanstående arbetsyta. |
name |
string |
Namnet på Itsm-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
region |
string |
Region där arbetsytan finns. Värden som stöds:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' |
ticketConfiguration |
string |
JSON-blob för konfigurationerna av ITSM-åtgärden. Alternativet CreateMultipleWorkItems ingår också i den här bloben. |
workspaceId |
string |
OMS LA-instansidentifierare. |
LogicAppReceiver
En logikappsmottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
callbackUrl |
string |
Återanrops-URL:en som http-begäran skickades till. |
|
name |
string |
Namnet på logikappmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
resourceId |
string |
Azure-resurs-ID för logikappmottagaren. |
|
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |
ReceiverStatus
Anger mottagarens status. Mottagare som inte är aktiverade får ingen kommunikation.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
|
NotSpecified |
string |
SmsReceiver
En SMS-mottagare.
Name | Typ | Description |
---|---|---|
countryCode |
string |
Landskoden för SMS-mottagaren. |
name |
string |
Namnet på SMS-mottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
phoneNumber |
string |
SMS-mottagarens telefonnummer. |
status |
Mottagarens status. |
VoiceReceiver
En röstmottagare.
Name | Typ | Description |
---|---|---|
countryCode |
string |
Landskoden för röstmottagaren. |
name |
string |
Namnet på röstmottagaren. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
phoneNumber |
string |
Röstmottagarens telefonnummer. |
WebhookReceiver
En webhook-mottagare.
Name | Typ | Standardvärde | Description |
---|---|---|---|
identifierUri |
string |
Anger identifierar-URI för aad-autentisering. |
|
name |
string |
Namnet på webhookens mottagare. Namn måste vara unika för alla mottagare i en åtgärdsgrupp. |
|
objectId |
string |
Anger webhooksappens objekt-ID för aad-autentisering. |
|
serviceUri |
string |
Den URI där webhooks ska skickas. |
|
tenantId |
string |
Anger klient-ID för aad-autentisering. |
|
useAadAuth |
boolean |
False |
Anger om AAD-autentisering ska användas eller inte. |
useCommonAlertSchema |
boolean |
False |
Anger om du vill använda ett vanligt aviseringsschema. |