forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Hub Generated] Review request for Microsoft.AlertsManagement to add …
…version preview/2021-01-01-preview (Azure#12748) * Adds base for updating Microsoft.AlertsManagement from version preview/2020-08-04-preview to version 2021-01-01-preview * Updates readme * Updates API version in new specs and examples * first commit * fix: "Client Api Version." * try add x-ms-long-running-operation-options * some renames * try to remove long operation * fixes from code review * fix typo * code review fixes * try fix lintdiff * remove the GET from the swagger , Add 200 to the POST * fix spelling * remove location header from the 200 response
- Loading branch information
Showing
4 changed files
with
443 additions
and
0 deletions.
There are no files selected for viewing
117 changes: 117 additions & 0 deletions
117
...ource-manager/Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2021-01-01-preview", | ||
| "title": "Azure Alerts Management Service Resource Provider", | ||
| "description": "Azure Alerts Management Service provides a single pane of glass of alerts across Azure Monitor." | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "securityDefinitions": { | ||
| "azure_auth": { | ||
| "type": "oauth2", | ||
| "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", | ||
| "flow": "implicit", | ||
| "description": "Azure Active Directory OAuth2 Flow", | ||
| "scopes": { | ||
| "user_impersonation": "impersonate your user account" | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/providers/Microsoft.AlertsManagement/operations": { | ||
| "get": { | ||
| "operationId": "Operations_List", | ||
| "description": "List all operations available through Azure Alerts Management Resource Provider.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK. Successfully retrieved operations list.", | ||
| "schema": { | ||
| "$ref": "#/definitions/operationsList" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-pageable": { | ||
| "nextLinkName": "nextLink" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "operation": { | ||
| "description": "Operation provided by provider", | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "Name of the operation" | ||
| }, | ||
| "display": { | ||
| "type": "object", | ||
| "description": "Properties of the operation", | ||
| "properties": { | ||
| "provider": { | ||
| "type": "string", | ||
| "description": "Provider name" | ||
| }, | ||
| "resource": { | ||
| "type": "string", | ||
| "description": "Resource name" | ||
| }, | ||
| "operation": { | ||
| "type": "string", | ||
| "description": "Operation name" | ||
| }, | ||
| "description": { | ||
| "type": "string", | ||
| "description": "Description of the operation" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "operationsList": { | ||
| "description": "Lists the operations available in the AlertsManagement RP.", | ||
| "properties": { | ||
| "nextLink": { | ||
| "description": "URL to fetch the next set of operations.", | ||
| "type": "string" | ||
| }, | ||
| "value": { | ||
| "description": "Array of operations", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/operation" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "value" | ||
| ] | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Client Api Version." | ||
| } | ||
| } | ||
| } |
271 changes: 271 additions & 0 deletions
271
...ger/Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,271 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2021-01-01-preview", | ||
| "title": "Azure Alerts Management Service Resource Provider", | ||
| "description": "APIs for managing a migration from Smart Detection to smart alerts." | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "securityDefinitions": { | ||
| "azure_auth": { | ||
| "type": "oauth2", | ||
| "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", | ||
| "flow": "implicit", | ||
| "description": "Azure Active Directory OAuth2 Flow", | ||
| "scopes": { | ||
| "user_impersonation": "impersonate your user account" | ||
| } | ||
| } | ||
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/migrateFromSmartDetection": { | ||
| "post": { | ||
| "tags": [ | ||
| "MigrateFromSmartDetection" | ||
| ], | ||
| "description": "Starts an asynchronous migration process of Smart Detection to smart alerts in an Application Insights resource. Use the HTTP address in the response location header to GET the status of the migration process.", | ||
| "operationId": "MigrateFromSmartDetection_StartMigration", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "name": "smartDetectionMigrationRequest", | ||
| "in": "body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/SmartDetectionMigrationRequest" | ||
| }, | ||
| "description": "The parameters controlling the migration process." | ||
| } | ||
| ], | ||
| "responses": { | ||
| "202": { | ||
| "description": "Migration request was accepted. Processing will start promptly.", | ||
| "schema": { | ||
| "$ref": "#/definitions/MigrationStatusResponse" | ||
| } | ||
| }, | ||
| "200": { | ||
| "description": "Migration for the requested resource was already completed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/MigrationStatusResponse" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/MigrationErrorResponse" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Migration Triggering": { | ||
| "$ref": "./examples/migrateFromSmartDetectionStartMigration.json" | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true, | ||
| "x-ms-long-running-operation-options": { | ||
| "final-state-via": "location" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "SmartDetectionMigrationRequest": { | ||
| "required": [ | ||
| "scope" | ||
| ], | ||
| "properties": { | ||
| "scope": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "The list of resource IDs that the requested migration should be performed on." | ||
| }, | ||
| "actionGroupCreationPolicy": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "Custom", | ||
| "Auto" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "ActionGroupCreationPolicy", | ||
| "values": [ | ||
| { | ||
| "value": "Custom", | ||
| "description": "Create all alert rules with a custom action group that is specified in 'customActionGroupName'." | ||
| }, | ||
| { | ||
| "value": "Auto", | ||
| "description": "Automatically create an action group for each unique setting in the Smart Detection settings." | ||
| } | ||
| ], | ||
| "modelAsString": true | ||
| }, | ||
| "description": "The policy for migrating the email settings in the Smart Detection Rules into action groups. If not specified, 'Auto' policy is used." | ||
| }, | ||
| "customActionGroupName": { | ||
| "type": "string", | ||
| "description": "A custom name of an existing action group to attach to the created alert rules. Required only when actionGroupCreationPolicy is set to 'Custom'." | ||
| } | ||
| }, | ||
| "description": "The Smart Detection migration request." | ||
| }, | ||
| "MigrationStatusResponse": { | ||
| "description": "Response for the quota submission request.", | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "description": "The migration resource identifier.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "name": { | ||
| "description": "The migration process name.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "readOnly": true, | ||
| "description": "Type of resource. \"Microsoft.AlertsManagement/migrateFromSmartDetection\"" | ||
| }, | ||
| "properties": { | ||
| "description": "The details of the migration response", | ||
| "x-ms-client-flatten": true, | ||
| "$ref": "#/definitions/MigrationStatusResponseProperties" | ||
| } | ||
| } | ||
| }, | ||
| "MigrationStatusResponseProperties": { | ||
| "required": [ | ||
| "migrationId", | ||
| "status", | ||
| "scope" | ||
| ], | ||
| "properties": { | ||
| "migrationId": { | ||
| "type": "string", | ||
| "description": "The migration process unique id." | ||
| }, | ||
| "status": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "Starting", | ||
| "InProcess", | ||
| "Deploying", | ||
| "Completed", | ||
| "Failed", | ||
| "Canceled" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "MigrationStatus", | ||
| "values": [ | ||
| { | ||
| "value": "Starting", | ||
| "description": "The migration was accepted and will start shortly." | ||
| }, | ||
| { | ||
| "value": "InProcess", | ||
| "description": "The migration is in progress." | ||
| }, | ||
| { | ||
| "value": "Deploying", | ||
| "description": "The migration template is deploying." | ||
| }, | ||
| { | ||
| "value": "Completed", | ||
| "description": "The migration completed successfully." | ||
| }, | ||
| { | ||
| "value": "Failed", | ||
| "description": "The migration failed." | ||
| }, | ||
| { | ||
| "value": "Canceled", | ||
| "description": "The migration was canceled by the user." | ||
| } | ||
| ], | ||
| "modelAsString": true | ||
| }, | ||
| "description": "The current status of the migration process" | ||
| }, | ||
| "scope": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "The list of resource IDs that the requested migration should be performed on." | ||
| }, | ||
| "armDeploymentName": { | ||
| "type": "string", | ||
| "description": "The name of the ARM deployment associated with the migration process." | ||
| } | ||
| }, | ||
| "description": "A migration status response." | ||
| }, | ||
| "MigrationErrorResponse": { | ||
| "description": "API error.", | ||
| "type": "object", | ||
| "properties": { | ||
| "error": { | ||
| "$ref": "#/definitions/MigrationErrorResponseBody", | ||
| "description": "The API error body.", | ||
| "x-ms-client-flatten": true | ||
| } | ||
| } | ||
| }, | ||
| "MigrationErrorResponseBody": { | ||
| "description": "API error body.", | ||
| "type": "object", | ||
| "properties": { | ||
| "code": { | ||
| "description": "Error code.", | ||
| "type": "string" | ||
| }, | ||
| "message": { | ||
| "description": "Error message indicating why the operation failed.", | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "SubscriptionIdParameter": { | ||
| "name": "subscriptionId", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The Azure subscription Id." | ||
| }, | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Client Api Version." | ||
| }, | ||
| "MigrationIdParameter": { | ||
| "name": "migrationId", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The ID of the migration process.", | ||
| "x-ms-parameter-location": "method" | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.