openapi-directory/api/azure.com/monitor-activityLogAlerts_API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"Azure Activity Log Alerts","version":"2017-04-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-ms-code-generation-settings":{"name":"MonitorManagementClient"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"monitor-activityLogAlerts_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/microsoft.insights/activityLogAlerts":{"get":{"description":"Get a list of all activity log alerts in a subscription.","operationId":"ActivityLogAlerts_ListBySubscriptionId","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertList"},"examples":{"List activity log alerts":{"$ref":"#/components/examples/List_activity_log_alerts"}}}}},"default":{"description":"An error occurred and the list of activity log alerts could not be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts":{"get":{"description":"Get a list of all activity log alerts in a resource group.","operationId":"ActivityLogAlerts_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertList"},"examples":{"List activity log alerts":{"$ref":"#/components/examples/List_activity_log_alerts"}}}}},"default":{"description":"An error occurred and the list of activity log alerts could not be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/activityLogAlerts/{activityLogAlertName}":{"delete":{"description":"Delete an activity log alert.","operationId":"ActivityLogAlerts_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ActivityLogAlertNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The activity log alert was successfully deleted."},"204":{"description":"The activity log alert does not exist. It may have already been deleted."},"default":{"description":"An error occurred and the activity log alert could not be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"description":"Get an activity log alert.","operationId":"ActivityLogAlerts_Get","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ActivityLogAlertNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertResource"},"examples":{"Get an activity log alert":{"$ref":"#/components/examples/Get_an_activity_log_alert"}}}}},"default":{"description":"An error occurred and the activity log alert could not be retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"description":"Updates an existing ActivityLogAlertResource's tags. To update other fields use the CreateOrUpdate method.","operationId":"ActivityLogAlerts_Update","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ActivityLogAlertNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertPatchBody"}}},"description":"Parameters supplied to the operation.","required":true},"responses":{"200":{"description":"An existing activity log alert was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertResource"},"examples":{"Patch an activity log alert":{"$ref":"#/components/examples/Patch_an_activity_log_alert"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"description":"Create a new activity log alert or update an existing one.","operationId":"ActivityLogAlerts_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ActivityLogAlertNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertResource"}}},"description":"The activity log alert to create or use for the update.","required":true},"responses":{"200":{"description":"An existing activity log alert was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertResource"},"examples":{"Create or update an activity log alert":{"$ref":"#/components/examples/Create_or_update_an_activity_log_alert"}}}}},"201":{"description":"A new activity log alert was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityLogAlertResource"},"examples":{"Create or update an activity log alert":{"$ref":"#/components/examples/Create_or_update_an_activity_log_alert"}}}}},"default":{"description":"An error occurred and the activity log alert could not be created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_activity_log_alerts":{"value":{"value":[{"id":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActivityLogAlerts/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlert","location":"Global","name":"SampleActivityLogAlert","properties":{"actions":{"actionGroups":[{"actionGroupId":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActionGroups/providers/microsoft.insights/actionGroups/SampleActionGroup","webhookProperties":{"sampleWebhookProperty":"samplePropertyValue"}}]},"condition":{"allOf":[{"equals":"Administrative","field":"Category"},{"equals":"Error","field":"Level"}]},"description":"Sample activity log alert description","enabled":true,"scopes":["subscriptions/187f412d-1758-44d9-b052-169e2564721d"]},"tags":{},"type":"Microsoft.Insights/ActivityLogAlerts"},{"id":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActivityLogAlerts/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlert2","location":"Global","name":"SampleActivityLogAlert2","properties":{"actions":{"actionGroups":[{"actionGroupId":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActionGroups/providers/microsoft.insights/actionGroups/SampleActionGroup","webhookProperties":{}}]},"condition":{"allOf":[{"equals":"Administrative","field":"Category"}]},"enabled":true,"scopes":["subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActivityLogAlerts"]},"tags":{},"type":"Microsoft.Insights/ActivityLogAlerts"}]}},"Get_an_activity_log_alert":{"value":{"id":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActivityLogAlerts/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlert","location":"Global","name":"SampleActivityLogAlert","properties":{"actions":{"actionGroups":[{"actionGroupId":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActionGroups/providers/microsoft.insights/actionGroups/SampleActionGroup","webhookProperties":{"sampleWebhookProperty":"samplePropertyValue"}}]},"condition":{"allOf":[{"equals":"Administrative","field":"Category"},{"equals":"Error","field":"Level"}]},"description":"Sample activity log alert description","enabled":true,"scopes":["subscriptions/187f412d-1758-44d9-b052-169e2564721d"]},"tags":{},"type":"Microsoft.Insights/ActivityLogAlerts"}},"Patch_an_activity_log_alert":{"value":{"id":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActivityLogAlerts/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlert","location":"Global","name":"SampleActivityLogAlert","properties":{"actions":{"actionGroups":[{"actionGroupId":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActionGroups/providers/microsoft.insights/actionGroups/SampleActionGroup","webhookProperties":{"sampleWebhookProperty":"samplePropertyValue"}}]},"condition":{"allOf":[{"equals":"Administrative","field":"Category"},{"equals":"Error","field":"Level"}]},"description":"Sample activity log alert description","enabled":false,"scopes":["/subscriptions/187f412d-1758-44d9-b052-169e2564721d"]},"tags":{"key1":"value1","key2":"value2"},"type":"Microsoft.Insights/ActivityLogAlerts"}},"Create_or_update_an_activity_log_alert":{"value":{"id":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlert","location":"Global","name":"SampleActivityLogAlert","properties":{"actions":{"actionGroups":[{"actionGroupId":"/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-ActionGroups/providers/microsoft.insights/actionGroups/SampleActionGroup","webhookProperties":{"sampleWebhookProperty":"samplePropertyValue"}}]},"condition":{"allOf":[{"equals":"Administrative","field":"Category"},{"equals":"Error","field":"Level"}]},"description":"Sample activity log alert description","enabled":true,"scopes":["subscriptions/187f412d-1758-44d9-b052-169e2564721d"]},"tags":{},"type":"Microsoft.Insights/ActivityLogAlerts"}}},"parameters":{"ActivityLogAlertNameParameter":{"description":"The name of the activity log alert.","in":"path","name":"activityLogAlertName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete an activity log alert":{"value":"SampleActivityLogAlert"},"Get an activity log alert":{"value":"SampleActivityLogAlert"},"Patch an activity log alert":{"value":"SampleActivityLogAlert"},"Create or update an activity log alert":{"value":"SampleActivityLogAlert"}}},"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List activity log alerts":{"value":"2017-04-01"},"Delete an activity log alert":{"value":"2017-04-01"},"Get an activity log alert":{"value":"2017-04-01"},"Patch an activity log alert":{"value":"2017-03-01-preview"},"Create or update an activity log alert":{"value":"2017-04-01"}}},"ResourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List activity log alerts":{"value":"Default-ActivityLogAlerts"},"Delete an activity log alert":{"value":"Default-ActivityLogAlerts"},"Get an activity log alert":{"value":"Default-ActivityLogAlerts"},"Patch an activity log alert":{"value":"Default-ActivityLogAlerts"},"Create or update an activity log alert":{"value":"Default-ActivityLogAlerts"}}},"SubscriptionIdParameter":{"description":"The Azure subscription Id.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List activity log alerts":{"value":"187f412d-1758-44d9-b052-169e2564721d"},"Delete an activity log alert":{"value":"187f412d-1758-44d9-b052-169e2564721d"},"Get an activity log alert":{"value":"187f412d-1758-44d9-b052-169e2564721d"},"Patch an activity log alert":{"value":"187f412d-1758-44d9-b052-169e2564721d"},"Create or update an activity log alert":{"value":"187f412d-1758-44d9-b052-169e2564721d"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ActivityLogAlert":{"description":"An Azure activity log alert.","properties":{"actions":{"$ref":"#/components/schemas/ActivityLogAlertActionList"},"condition":{"$ref":"#/components/schemas/ActivityLogAlertAllOfCondition"},"description":{"description":"A description of this activity log alert.","type":"string"},"enabled":{"default":true,"description":"Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated.","type":"boolean"},"scopes":{"description":"A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item.","items":{"type":"string"},"type":"array"}},"required":["scopes","condition","actions"]},"ActivityLogAlertActionGroup":{"description":"A pointer to an Azure Action Group.","properties":{"actionGroupId":{"description":"The resourceId of the action group. This cannot be null or empty.","type":"string"},"webhookProperties":{"additionalProperties":{"type":"string"},"description":"the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload."}},"required":["actionGroupId"]},"ActivityLogAlertActionList":{"description":"A list of activity log alert actions.","properties":{"actionGroups":{"description":"The list of activity log alerts.","items":{"$ref":"#/components/schemas/ActivityLogAlertActionGroup"},"type":"array"}}},"ActivityLogAlertAllOfCondition":{"description":"An Activity Log alert condition that is met when all its member conditions are met.","properties":{"allOf":{"description":"The list of activity log alert conditions.","items":{"$ref":"#/components/schemas/ActivityLogAlertLeafCondition"},"type":"array"}},"required":["allOf"]},"ActivityLogAlertLeafCondition":{"description":"An Activity Log alert condition that is met by comparing an activity log field and value.","properties":{"equals":{"description":"The field value will be compared to this value (case-insensitive) to determine if the condition is met.","type":"string"},"field":{"description":"The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'.","type":"string"}},"required":["field","equals"]},"ActivityLogAlertList":{"description":"A list of activity log alerts.","properties":{"nextLink":{"description":"Provides the link to retrieve the next set of elements.","type":"string"},"value":{"description":"The list of activity log alerts.","items":{"$ref":"#/components/schemas/ActivityLogAlertResource"},"type":"array"}}},"ActivityLogAlertPatch":{"description":"An Azure activity log alert for patch operations.","properties":{"enabled":{"default":true,"description":"Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated.","type":"boolean"}}},"ActivityLogAlertPatchBody":{"description":"An activity log alert object for the body of patch operations.","properties":{"properties":{"$ref":"#/components/schemas/ActivityLogAlertPatch"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags"}}},"ActivityLogAlertResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"An activity log alert resource.","properties":{"properties":{"$ref":"#/components/schemas/ActivityLogAlert"}}},"ErrorResponse":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"},"Resource":{"description":"An azure resource object","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"location":{"description":"Resource location","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"Azure resource name","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags"},"type":{"description":"Azure resource type","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true}}}}