diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6365a0ab3ac3..77d44867904a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,7 @@ Add a changelog entry for this PR by answering the following questions: - [ ] Other, please clarify 2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. 3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. - 4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published. + 4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published. - [ ] SDK of .NET (need service team to ensure code readiness) - [ ] SDK of Python - [ ] SDK of Java diff --git a/.github/comment.yml b/.github/comment.yml index d3da85602813..27fdaa1b3350 100644 --- a/.github/comment.yml +++ b/.github/comment.yml @@ -48,7 +48,7 @@ openapiHub: https://portal.azure-devex-tools.com keywords: - "I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow." - onOpenedComments: "Hi, @${PRAuthor} Thanks for your PR. I am workflow bot for review process. Here are some small tips.
  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use [API Specs Comparison Report Generator](${openapiHub}/tools/diff?pr=${owner}/${repo}/${PRNumber})
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md)

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com" + onOpenedComments: "Hi, @${PRAuthor} Thanks for your PR. I am workflow bot for review process. Here are some small tips.
  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use [API Specs Comparison Report Generator](${openapiHub}/tools/diff?pr=${owner}/${repo}/${PRNumber})
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md)

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com" - rule: type: PROpen diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 96c8698060a2..6a022d31b7bc 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -145,6 +145,12 @@ reviewers: - weidongxu-microsoft +- rule: + paths: + - "specification/securityinsights/**" + reviewers: + - dw511214992 + - rule: paths: diff --git a/custom-words.txt b/custom-words.txt index 0e244e8e710e..c46ec6cd6978 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2480,6 +2480,22 @@ loadtest xvalue yvalue servermetrics +napt +Napt +NAPT +Plmn +IMSI +UE's +Preemptable +Ambr +AMBR +rfsp +Rfsp +snssai +Snssai +NSSAI +Tbps +Vuln IAASVM Quickbase Smartsheet \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetPrivateLinkGroupResource.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetPrivateLinkGroupResource.json index b645701ca4f9..3ed766b7adff 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetPrivateLinkGroupResource.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementGetPrivateLinkGroupResource.json @@ -9,16 +9,16 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/privateLinkSubResourceName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateLinkResources/Gateway", "name": "Gateway", "type": "Microsoft.ApiManagement/service/privateLinkResources", "properties": { "groupId": "Gateway", "requiredMembers": [ - "Gateway_west_us" + "Gateway" ], "requiredZoneNames": [ - "privateLink.azure.api.net" + "privateLink.azure-api.net" ] } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListPrivateLinkGroupResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListPrivateLinkGroupResources.json index 3aceaf90f2da..220184b1ce7f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListPrivateLinkGroupResources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListPrivateLinkGroupResources.json @@ -16,10 +16,10 @@ "properties": { "groupId": "Gateway", "requiredMembers": [ - "Gateway_west_us" + "Gateway" ], "requiredZoneNames": [ - "privateLink.azure.api.net" + "privateLink.azure-api.net" ] } } diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/Personalizer.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/Personalizer.json new file mode 100644 index 000000000000..b3782e34b31f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/Personalizer.json @@ -0,0 +1,1981 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1.1-preview.3", + "title": "Personalizer Client v1.1-preview.3", + "description": "Personalizer Service is an Azure Cognitive Service that makes it easy to target content and experiences without complex pre-analysis or cleanup of past data. Given a context and featurized content, the Personalizer Service returns which content item to show to users in rewardActionId. As rewards are sent in response to the use of rewardActionId, the reinforcement learning algorithm will improve the model and improve performance of future rank calls." + }, + "basePath": "/personalizer/v1.1-preview.3", + "schemes": [ + "https" + ], + "paths": { + "/configurations/service": { + "get": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Get Service Configuration.", + "description": "Get the Personalizer service configuration.", + "operationId": "ServiceConfiguration_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Get request": { + "$ref": "./examples/ServiceConfiguration_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Update Service Configuration.", + "description": "Update the Personalizer service configuration.", + "operationId": "ServiceConfiguration_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "config", + "in": "body", + "description": "The personalizer service configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceConfiguration" + } + }, + "default": { + "description": "Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_Update request": { + "$ref": "./examples/ServiceConfiguration_Update.json" + } + } + } + }, + "/configurations/policy": { + "get": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Get Policy.", + "description": "Get the Learning Settings currently used by the Personalizer service.", + "operationId": "Policy_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Get request": { + "$ref": "./examples/Policy_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Update Policy.", + "description": "Update the Learning Settings that the Personalizer service will use to train models.", + "operationId": "Policy_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "policy", + "in": "body", + "description": "The learning settings.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + }, + "default": { + "description": "Invalid policy configuration.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Policy_Update request": { + "$ref": "./examples/Policy_Update.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Reset Policy.", + "description": "Resets the learning settings of the Personalizer service to default.", + "operationId": "Policy_Reset", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PolicyContract" + } + } + }, + "x-ms-examples": { + "Successful Policy_Reset request": { + "$ref": "./examples/Policy_Reset.json" + } + } + } + }, + "/evaluations/{evaluationId}": { + "get": { + "tags": [ + "EvaluationsV1Dot1Preview1" + ], + "summary": "Get Evaluation.", + "description": "Get the Offline Evaluation associated with the Id.", + "operationId": "Evaluations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "Id of the Offline Evaluation.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + } + }, + "default": { + "description": "Offline Evaluation not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluations_Get request": { + "$ref": "./examples/Evaluations_Get.json" + } + } + }, + "delete": { + "tags": [ + "EvaluationsV1Dot1Preview1" + ], + "summary": "Delete Evaluation.", + "description": "Delete the Offline Evaluation associated with the Id.", + "operationId": "Evaluations_Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "evaluationId", + "in": "path", + "description": "Id of the Offline Evaluation to delete.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Evaluations_Delete request": { + "$ref": "./examples/Evaluations_Delete.json" + } + } + } + }, + "/evaluations": { + "get": { + "tags": [ + "EvaluationsV1Dot1Preview1" + ], + "summary": "List Offline Evaluations.", + "description": "List of all Offline Evaluations.", + "operationId": "Evaluations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Evaluation" + } + } + } + }, + "x-ms-examples": { + "Successful Evaluations_List request": { + "$ref": "./examples/Evaluations_List.json" + } + } + }, + "post": { + "tags": [ + "EvaluationsV1Dot1Preview1" + ], + "summary": "Create Offline Evaluation.", + "description": "Submit a new Offline Evaluation job.", + "operationId": "Evaluations_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "evaluation", + "in": "body", + "description": "The Offline Evaluation job definition.", + "required": true, + "schema": { + "$ref": "#/definitions/EvaluationContract" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Evaluation" + }, + "headers": { + "Location": { + "description": "Location of the Offline Evaluation status and data.", + "type": "string" + } + } + }, + "default": { + "description": "Invalid evaluation contract.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluations_Create request": { + "$ref": "./examples/Evaluations_Create.json" + } + } + } + }, + "/events/{eventId}/reward": { + "post": { + "tags": [ + "Events" + ], + "summary": "Post Reward.", + "description": "Report reward between 0 and 1 that resulted from using the action specified in rewardActionId, for the specified event.", + "operationId": "Events_Reward", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event id this reward applies to.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "reward", + "in": "body", + "description": "The reward should be a floating point number, typically between 0 and 1.", + "required": true, + "schema": { + "$ref": "#/definitions/RewardRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid reward request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Events_Reward request": { + "$ref": "./examples/Events_Reward.json" + } + } + } + }, + "/events/{eventId}/activate": { + "post": { + "tags": [ + "Events" + ], + "summary": "Activate Event.", + "description": "Report that the specified event was actually used (e.g. by being displayed to the user) and a reward should be expected for it.", + "operationId": "Events_Activate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "eventId", + "in": "path", + "description": "The event ID to be activated.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid activate event request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Events_Activate request": { + "$ref": "./examples/Events_Activate.json" + } + } + } + }, + "/configurations/applyFromEvaluation": { + "post": { + "tags": [ + "ConfigurationsV1Dot1Preview1" + ], + "summary": "Apply Learning Settings and model from a pre-existing Offline Evaluation, making them the current online Learning Settings and model and replacing the previous ones.", + "operationId": "ServiceConfiguration_ApplyFromEvaluation", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Reference to the policy within the evaluation.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyReferenceContract" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Learning Settings not found in evaluation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful ServiceConfiguration_ApplyFromEvaluation request": { + "$ref": "./examples/ServiceConfiguration_ApplyFromEvaluation.json" + } + } + } + }, + "/logs/interactions": { + "post": { + "tags": [ + "LogsV1Dot1Preview2" + ], + "summary": "Post interactions.", + "description": "The endpoint is intended to be used from within a SDK for logging interactions and accepts specific format defined in https://github.com/VowpalWabbit/reinforcement_learning. This endpoint should not be used by the customer.", + "operationId": "Log_Interactions", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Interactions binary payload.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Log_Interactions request": { + "$ref": "./examples/Log_Interactions.json" + } + } + } + }, + "/logs/observations": { + "post": { + "tags": [ + "LogsV1Dot1Preview2" + ], + "summary": "Post observations.", + "description": "The endpoint is intended to be used from within a SDK for logging observations and accepts specific format defined in https://github.com/VowpalWabbit/reinforcement_learning. This endpoint should not be used by the customer.", + "operationId": "Log_Observations", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Observations binary payload.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Log_Observations request": { + "$ref": "./examples/Log_Observations.json" + } + } + } + }, + "/logs": { + "delete": { + "tags": [ + "LogsV1Dot1Preview2" + ], + "summary": "Deletes Logs.", + "description": "Delete all logs of Rank and Reward calls stored by Personalizer.", + "operationId": "Log_Delete", + "consumes": [], + "produces": [], + "parameters": [], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Successful Log_Delete request": { + "$ref": "./examples/Log_Delete.json" + } + } + } + }, + "/logs/properties": { + "get": { + "tags": [ + "LogsV1Dot1Preview2" + ], + "summary": "Get Log Properties.", + "description": "Get properties of the Personalizer logs.", + "operationId": "Log_GetProperties", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LogsProperties" + } + }, + "default": { + "description": "Log properties not found.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Log_GetProperties request": { + "$ref": "./examples/Log_GetProperties.json" + } + } + } + }, + "/model": { + "get": { + "tags": [ + "ModelV1Dot1Preview3" + ], + "summary": "Get Model.", + "description": "Get the model file generated by Personalizer service.", + "operationId": "Model_Get", + "consumes": [], + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "signed", + "description": "True if requesting signed model zip archive, false otherwise.", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Requested resource does not exist on the server.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Model_Get request": { + "$ref": "./examples/Model_Get.json" + } + } + }, + "put": { + "tags": [ + "ModelV1Dot1Preview3" + ], + "summary": "Put the digitally signed model file.", + "description": "Replace the existing model file for the Personalizer service.", + "operationId": "Model_Import", + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "The digitally signed model file obtained from getting the model.", + "required": true, + "schema": { + "format": "binary", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Given model file is not signed or does not have a valid signature.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Model_Import request": { + "$ref": "./examples/Model_Import.json" + } + } + }, + "delete": { + "tags": [ + "ModelV1Dot1Preview3" + ], + "summary": "Reset Model.", + "description": "Resets the model file generated by Personalizer service.", + "operationId": "Model_Reset", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Model reset failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Model_Reset request": { + "$ref": "./examples/Model_Reset.json" + } + } + } + }, + "/model/properties": { + "get": { + "tags": [ + "ModelV1Dot1Preview3" + ], + "summary": "Get Model Properties.", + "description": "Get properties of the model file generated by Personalizer service.", + "operationId": "Model_GetProperties", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelProperties" + } + } + }, + "x-ms-examples": { + "Successful Model_GetProperties request": { + "$ref": "./examples/Model_GetProperties.json" + } + } + } + }, + "/multislot/events/{eventId}/reward": { + "post": { + "tags": [ + "MultiSlotEvents" + ], + "summary": "Post multi-slot Rewards.", + "description": "Report reward that resulted from using the action specified in rewardActionId for the slot.", + "operationId": "MultiSlotEvents_Reward", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "eventId", + "description": "The event id this reward applies to.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "in": "body", + "name": "body", + "description": "List of slot id and reward values. The reward should be a floating point number, typically between 0 and 1.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiSlotRewardRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid reward request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful MultiSlotEvents_Reward request": { + "$ref": "./examples/MultiSlotEvents_Reward.json" + } + } + } + }, + "/multislot/events/{eventId}/activate": { + "post": { + "tags": [ + "MultiSlotEvents" + ], + "summary": "Activate multi-slot Event.", + "description": "Report that the specified event was actually used or displayed to the user and a rewards should be expected for it.", + "operationId": "MultiSlotEvents_Activate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "eventId", + "description": "The event ID this activation applies to.", + "required": true, + "type": "string", + "maxLength": 256 + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Invalid activate event request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful MultiSlotEvents_Activate request": { + "$ref": "./examples/MultiSlotEvents_Activate.json" + } + } + } + }, + "/multislot/rank": { + "post": { + "tags": [ + "MultiSlotRank" + ], + "summary": "Post multi-slot Rank.", + "description": "Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.", + "operationId": "MultiSlot_Rank", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "A Personalizer multi-slot Rank request.", + "required": true, + "schema": { + "$ref": "#/definitions/MultiSlotRankRequest" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MultiSlotRankResponse" + } + }, + "default": { + "description": "Invalid request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful MultiSlot_Rank request": { + "$ref": "./examples/MultiSlot_Rank.json" + } + } + } + }, + "/rank": { + "post": { + "tags": [ + "Rank" + ], + "summary": "Post Rank.", + "description": "Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId.", + "operationId": "Rank", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "rankRequest", + "in": "body", + "description": "A Personalizer Rank request.", + "required": true, + "schema": { + "$ref": "#/definitions/RankRequest" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RankResponse" + } + }, + "default": { + "description": "Invalid request.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Rank request": { + "$ref": "./examples/Rank.json" + } + } + } + } + }, + "definitions": { + "ServiceConfiguration": { + "description": "The configuration of the service.", + "required": [ + "rewardWaitTime", + "defaultReward", + "rewardAggregation", + "explorationPercentage", + "modelExportFrequency", + "logRetentionDays" + ], + "type": "object", + "properties": { + "rewardWaitTime": { + "format": "duration", + "description": "The time span waited until a request is marked with the default reward\r\nand should be between 5 seconds and 2 days.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string" + }, + "defaultReward": { + "format": "float", + "description": "The reward given if a reward is not received within the specified wait time.", + "maximum": 1, + "minimum": -1, + "type": "number" + }, + "rewardAggregation": { + "description": "The function used to process rewards, if multiple reward scores are received before rewardWaitTime is over.", + "maxLength": 256, + "type": "string" + }, + "explorationPercentage": { + "format": "float", + "description": "The percentage of rank responses that will use exploration.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "modelExportFrequency": { + "format": "duration", + "description": "Personalizer will start using the most updated trained model for online ranks automatically every specified time period.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string" + }, + "logMirrorEnabled": { + "description": "Flag indicates whether log mirroring is enabled.", + "type": "boolean" + }, + "logMirrorSasUri": { + "description": "Azure storage account container SAS URI for log mirroring.", + "type": "string" + }, + "logRetentionDays": { + "format": "int32", + "description": "Number of days historical logs are to be maintained. -1 implies the logs will never be deleted.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "lastConfigurationEditDate": { + "format": "date-time", + "description": "Last time model training configuration was updated", + "type": "string" + }, + "learningMode": { + "description": "Learning Modes for Personalizer", + "enum": [ + "Online", + "Apprentice", + "LoggingOnly" + ], + "type": "string", + "x-ms-enum": { + "name": "LearningMode", + "modelAsString": true + } + }, + "isAutoOptimizationEnabled": { + "description": "Flag indicating whether Personalizer will automatically optimize Learning Settings by running Offline Evaluations periodically.", + "type": "boolean" + }, + "autoOptimizationFrequency": { + "format": "duration", + "description": "Frequency of automatic optimization. Only relevant if IsAutoOptimizationEnabled is true.\r\nFor example, PT5M (5 mins). For information about the time format,\r\n\\r\\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string" + }, + "autoOptimizationStartDate": { + "format": "date-time", + "description": "Date when the first automatic optimization evaluation must be performed. Only relevant if IsAutoOptimizationEnabled is true.", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Used to return an error to the client", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/PersonalizerError" + } + } + }, + "PersonalizerError": { + "description": "The error object.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Error Codes returned by Personalizer", + "enum": [ + "BadRequest", + "InvalidServiceConfiguration", + "InvalidLearningModeServiceConfiguration", + "InvalidPolicyConfiguration", + "InvalidPolicyContract", + "InvalidEvaluationContract", + "DuplicateCustomPolicyNames", + "NoLogsExistInDateRange", + "LogsSizeExceedAllowedLimit", + "InvalidRewardRequest", + "InvalidEventIdToActivate", + "InvalidRankRequest", + "InvalidExportLogsRequest", + "InvalidRequest", + "InvalidContainer", + "InvalidModelMetadata", + "ApprenticeModeNeverTurnedOn", + "MissingAppId", + "InvalidRewardWaitTime", + "InvalidLogRetentionDays", + "InvalidMultiSlotApiAccess", + "PayloadSizeExceeded", + "InvalidModelImportSignature", + "InvalidModelImportFormat", + "InvalidApiAccess", + "ModelFileAccessDenied", + "ProblemTypeIncompatibleWithAutoOptimization", + "ResourceNotFound", + "FrontEndNotFound", + "EvaluationNotFound", + "LearningSettingsNotFound", + "EvaluationModelNotFound", + "LogsPropertiesNotFound", + "ModelRankingError", + "InternalServerError", + "RankNullResponse", + "UpdateConfigurationFailed", + "ModelResetFailed", + "ModelPublishFailed", + "ModelMetadataUpdateFailed", + "OperationNotAllowed" + ], + "type": "string", + "x-ms-enum": { + "name": "PersonalizerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "BadRequest", + "description": "Request could not be understood by the server." + }, + { + "value": "InvalidServiceConfiguration", + "description": "Invalid service configuration." + }, + { + "value": "InvalidLearningModeServiceConfiguration", + "description": "Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call." + }, + { + "value": "InvalidPolicyConfiguration", + "description": "Invalid policy configuration." + }, + { + "value": "InvalidPolicyContract", + "description": "Invalid policy contract." + }, + { + "value": "InvalidEvaluationContract", + "description": "Invalid evaluation contract." + }, + { + "value": "DuplicateCustomPolicyNames", + "description": "Custom policy names should be unique." + }, + { + "value": "NoLogsExistInDateRange", + "description": "No logs exist in date range." + }, + { + "value": "LogsSizeExceedAllowedLimit", + "description": "Total size of logs exceed allowed limit." + }, + { + "value": "InvalidRewardRequest", + "description": "Invalid reward request." + }, + { + "value": "InvalidEventIdToActivate", + "description": "Invalid activate event request." + }, + { + "value": "InvalidRankRequest", + "description": "Invalid request." + }, + { + "value": "InvalidExportLogsRequest", + "description": "Invalid request." + }, + { + "value": "InvalidRequest", + "description": "Invalid request." + }, + { + "value": "InvalidContainer", + "description": "SAS Uri must be the Uri to a container that has write permissions." + }, + { + "value": "InvalidModelMetadata", + "description": "Invalid model metadata." + }, + { + "value": "ApprenticeModeNeverTurnedOn", + "description": "Apprentice mode never turned on." + }, + { + "value": "MissingAppId", + "description": "AppId is missing in the header." + }, + { + "value": "InvalidRewardWaitTime", + "description": "Reward wait time should be either 10 minutes or 4 hours or 12 hours or 24 hours" + }, + { + "value": "InvalidLogRetentionDays", + "description": "Log Retention Days must be -1 to store indefinitely or must be at least reward wait time plus 1 day (rounded up)" + }, + { + "value": "InvalidMultiSlotApiAccess", + "description": "Multi-slot feature is currently disabled. Please follow multi-slot Personalizer documentation to update your loop settings to enable multi-slot functionality." + }, + { + "value": "PayloadSizeExceeded", + "description": "Exceeds maximum allowed payload size." + }, + { + "value": "InvalidModelImportSignature", + "description": "Given model file is not signed or does not have a valid signature." + }, + { + "value": "InvalidModelImportFormat", + "description": "Given model file format is invalid." + }, + { + "value": "InvalidApiAccess", + "description": "Api is currently disabled for the instance." + }, + { + "value": "ModelFileAccessDenied", + "description": "Key vault Key used for customer managed key cannot be accessed." + }, + { + "value": "ProblemTypeIncompatibleWithAutoOptimization", + "description": "Auto-optimization is not compatible with multi-slot personalization." + }, + { + "value": "ResourceNotFound", + "description": "Requested resource does not exist on the server." + }, + { + "value": "FrontEndNotFound", + "description": "Front end not found." + }, + { + "value": "EvaluationNotFound", + "description": "Offline Evaluation not found." + }, + { + "value": "LearningSettingsNotFound", + "description": "Learning Settings not found in evaluation." + }, + { + "value": "EvaluationModelNotFound", + "description": "Model not found in evaluation." + }, + { + "value": "LogsPropertiesNotFound", + "description": "Log properties not found." + }, + { + "value": "ModelRankingError", + "description": "Error while ranking actions using model. Please verify the learning settings are valid." + }, + { + "value": "InternalServerError", + "description": "A generic error has occurred on the server." + }, + { + "value": "RankNullResponse", + "description": "Rank call returned null response." + }, + { + "value": "UpdateConfigurationFailed", + "description": "Failed to update configuration." + }, + { + "value": "ModelResetFailed", + "description": "Model reset failed." + }, + { + "value": "ModelPublishFailed", + "description": "Model publish failed." + }, + { + "value": "ModelMetadataUpdateFailed", + "description": "Model metadata update failed." + }, + { + "value": "OperationNotAllowed", + "description": "This operation is not allowed at this time." + } + ] + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + }, + "target": { + "description": "Error source element.", + "type": "string" + }, + "details": { + "description": "An array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/PersonalizerError" + } + }, + "innerError": { + "$ref": "#/definitions/InternalError" + } + } + }, + "InternalError": { + "description": "An object containing more specific information than the parent object about the error.", + "type": "object", + "properties": { + "code": { + "description": "Detailed error code.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InternalError" + } + } + }, + "PolicyContract": { + "description": "Learning settings specifying how to train the model.", + "required": [ + "name", + "arguments" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the learning settings.", + "maxLength": 256, + "type": "string" + }, + "arguments": { + "description": "Arguments of the learning settings.", + "maxLength": 1024, + "type": "string" + } + } + }, + "Evaluation": { + "description": "A counterfactual evaluation.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the evaluation.", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the evaluation.", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "The start time of the evaluation.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The end time of the evaluation.", + "type": "string", + "readOnly": true + }, + "jobId": { + "description": "The ID of the job processing the evaluation.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the job processing the evaluation.", + "enum": [ + "completed", + "pending", + "failed", + "notSubmitted", + "timeout", + "optimalPolicyApplied", + "onlinePolicyRetained" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EvaluationJobStatus", + "modelAsString": true + } + }, + "policyResults": { + "description": "The results of the evaluation.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResult" + } + }, + "featureImportance": { + "description": "Feature Importance.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "evaluationType": { + "description": "Evaluation type (manual or through Automatic Optimization).", + "enum": [ + "Manual", + "Auto" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationType", + "modelAsString": true + } + }, + "optimalPolicy": { + "description": "Thr optimal policy.", + "type": "string" + }, + "creationTime": { + "description": "Creation time.", + "format": "date-time", + "type": "string" + } + } + }, + "PolicyResult": { + "description": "This class contains the Learning Settings information and the results of the Offline Evaluation using that policy.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Learning Settings.", + "type": "string", + "readOnly": true + }, + "arguments": { + "description": "The arguments of the Learning Settings.", + "type": "string", + "readOnly": true + }, + "policySource": { + "description": "The source of the Learning Settings.", + "enum": [ + "Online", + "Baseline", + "Random", + "Custom", + "OfflineExperimentation" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PolicySource", + "modelAsString": true + } + }, + "summary": { + "description": "The aggregate results of the Offline Evaluation.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyResultSummary" + }, + "readOnly": true + }, + "totalSummary": { + "description": "The aggregate total of the Offline Evaluation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyResultSummary" + } + ], + "readOnly": true + } + } + }, + "PolicyResultSummary": { + "description": "This class contains the summary of evaluating a policy on a counterfactual evaluation.", + "type": "object", + "properties": { + "timeStamp": { + "format": "date-time", + "description": "Timestamp of the aggregation.", + "type": "string", + "readOnly": true + }, + "ipsEstimatorNumerator": { + "format": "float", + "description": "Numerator for IPS estimator.", + "type": "number", + "readOnly": true + }, + "ipsEstimatorDenominator": { + "format": "float", + "description": "Denominator for IPS estimator.", + "type": "number", + "readOnly": true + }, + "snipsEstimatorDenominator": { + "format": "float", + "description": "Denominator for SNIPS estimator.", + "type": "number", + "readOnly": true + }, + "aggregateTimeWindow": { + "format": "duration", + "description": "Time window for aggregation.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations", + "type": "string", + "readOnly": true + }, + "nonZeroProbability": { + "format": "float", + "description": "Probability of non-zero values for the Policy evaluation.", + "type": "number" + }, + "sumOfSquares": { + "format": "float", + "description": "Sum of Squares for the Policy evaluation results.", + "type": "number", + "readOnly": true + }, + "confidenceInterval": { + "format": "float", + "description": "Gaussian confidence interval for the Policy evaluation.", + "type": "number", + "readOnly": true + }, + "averageReward": { + "format": "float", + "description": "Average reward.", + "type": "number", + "readOnly": true + } + } + }, + "PolicyReferenceContract": { + "description": "Reference to the policy within the evaluation.", + "required": [ + "evaluationId", + "policyName" + ], + "type": "object", + "properties": { + "evaluationId": { + "description": "Evaluation Id of the evaluation.", + "maxLength": 256, + "type": "string" + }, + "policyName": { + "description": "Name of the learning settings.", + "maxLength": 256, + "type": "string" + } + } + }, + "EvaluationContract": { + "description": "A counterfactual evaluation.", + "required": [ + "name", + "startTime", + "endTime", + "policies" + ], + "type": "object", + "properties": { + "enableOfflineExperimentation": { + "description": "True if the evaluation should explore for a more optimal learning settings.", + "type": "boolean" + }, + "name": { + "description": "The name of the evaluation.", + "maxLength": 256, + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the evaluation.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of the evaluation.", + "type": "string" + }, + "policies": { + "description": "Additional learning settings to evaluate.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyContract" + } + } + } + }, + "RewardRequest": { + "description": "Reward given to a rank response.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "format": "float", + "description": "Reward to be assigned to an action. Value is a float calculated by your application, typically between 0 and 1, and must be between -1 and 1.", + "type": "number" + } + } + }, + "LogsProperties": { + "description": "Properties related to data used to train the model.", + "type": "object", + "properties": { + "dateRange": { + "description": "Date range.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DateRange" + } + ], + "readOnly": true + } + } + }, + "DateRange": { + "description": "A date range starting at From and ending at To.", + "type": "object", + "properties": { + "from": { + "format": "date-time", + "description": "Start date for the range.", + "type": "string", + "readOnly": true + }, + "to": { + "format": "date-time", + "description": "End date for the range.", + "type": "string", + "readOnly": true + } + } + }, + "ModelProperties": { + "description": "Properties related to the trained model.", + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "description": "Creation time of the model.", + "type": "string", + "readOnly": true + }, + "lastModifiedTime": { + "format": "date-time", + "description": "Last time the model was modified.", + "type": "string", + "readOnly": true + } + } + }, + "SlotReward": { + "required": [ + "slotId", + "value" + ], + "type": "object", + "properties": { + "slotId": { + "description": "Slot id for which we are sending the reward.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "value": { + "format": "float", + "description": "Reward to be assigned to slotId. Value should be between -1 and 1 inclusive.", + "type": "number" + } + } + }, + "MultiSlotRewardRequest": { + "description": "Reward given to a list of slots.", + "required": [ + "reward" + ], + "type": "object", + "properties": { + "reward": { + "description": "List of SlotRewards", + "type": "array", + "items": { + "$ref": "#/definitions/SlotReward" + } + } + } + }, + "RankRequest": { + "description": "Request a set of actions to be ranked by the Personalizer service.", + "required": [ + "actions" + ], + "type": "object", + "properties": { + "contextFeatures": { + "description": "Features of the context used for Personalizer as a\r\ndictionary of dictionaries. This is determined by your application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, aggregated data about time and date, etc.\r\nFeatures should not include personally identifiable information (PII),\r\nunique UserIDs, or precise timestamps.", + "type": "array", + "items": { + "type": "object" + } + }, + "actions": { + "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.\r\nThe first item in the array will be used as Baseline item in Offline Evaluations.", + "type": "array", + "items": { + "$ref": "#/definitions/RankableAction" + } + }, + "excludedActions": { + "description": "The set of action ids to exclude from ranking.\r\nPersonalizer will consider the first non-excluded item in the array as the Baseline action when performing Offline Evaluations.", + "type": "array", + "items": { + "type": "string" + } + }, + "eventId": { + "description": "Optionally pass an eventId that uniquely identifies this Rank event.\r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a Personalizer call.", + "maxLength": 256, + "type": "string" + }, + "deferActivation": { + "description": "Send false if it is certain the rewardActionId in rank results will be shown to the user, therefore\r\nPersonalizer will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the action specified in the rank results,\r\n(e.g. because the page is rendering later, or the Rank results may be overridden by code further downstream).\r\nYou must call the Activate Event API if the event output is shown to users, otherwise Rewards will be ignored.", + "default": false, + "type": "boolean" + } + } + }, + "RankableAction": { + "description": "An action with its associated features used for ranking.", + "required": [ + "id", + "features" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the action.", + "maxLength": 256, + "type": "string" + }, + "features": { + "description": "List of dictionaries containing features.", + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "SlotRequest": { + "description": "A slot with it's associated features and list of excluded actions", + "required": [ + "baselineAction", + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Slot ID", + "type": "string" + }, + "features": { + "description": "List of dictionaries containing slot features.", + "type": "array", + "items": { + "type": "object" + } + }, + "excludedActions": { + "description": "List of excluded action Ids.", + "type": "array", + "items": { + "type": "string" + } + }, + "baselineAction": { + "description": "The 'baseline action' ID for the slot.\r\nThe BaselineAction is the Id of the Action your application would use in that slot if Personalizer didn't exist.\r\nBaselineAction must be defined for every slot.\r\nBaselineAction should never be part of ExcludedActions.\r\nEach slot must have a unique BaselineAction which corresponds to an an action from the event's Actions list.", + "type": "string" + } + } + }, + "MultiSlotRankRequest": { + "required": [ + "actions", + "slots" + ], + "type": "object", + "properties": { + "contextFeatures": { + "description": "Features of the context used for Personalizer as a\r\ndictionary of dictionaries. This is determined by your application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, aggregated data about time and date, etc.\r\nFeatures should not include personally identifiable information (PII),\r\nunique UserIDs, or precise timestamps.", + "type": "array", + "items": { + "type": "object" + } + }, + "actions": { + "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.\r\nThe first item in the array will be used as Baseline item in Offline Evaluations.", + "type": "array", + "items": { + "$ref": "#/definitions/RankableAction" + } + }, + "slots": { + "description": "The set of slots the Personalizer service should select actions for.\r\nThe set should not contain more than 50 slots.", + "type": "array", + "items": { + "$ref": "#/definitions/SlotRequest" + } + }, + "eventId": { + "description": "Optionally pass an eventId that uniquely identifies this Rank event.\r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a Personalizer call.", + "maxLength": 256, + "type": "string" + }, + "deferActivation": { + "description": "Send false if it is certain the rewardActionId in rank results will be shown to the user, therefore\r\nPersonalizer will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the action specified in the rank results,\r\n(e.g. because the page is rendering later, or the Rank results may be overridden by code further downstream).\r\nYou must call the Activate Event API if the event output is shown to users, otherwise Rewards will be ignored.", + "default": false, + "type": "boolean" + } + } + }, + "SlotResponse": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Id is the slot ID.", + "maxLength": 256, + "type": "string" + }, + "rewardActionId": { + "description": "RewardActionID is the action ID recommended by Personalizer.", + "maxLength": 256, + "type": "string", + "readOnly": true + } + } + }, + "MultiSlotRankResponse": { + "type": "object", + "properties": { + "slots": { + "description": "Each slot has a corresponding rewardActionID which is the action ID recommended by Personalizer.", + "type": "array", + "items": { + "$ref": "#/definitions/SlotResponse" + }, + "readOnly": true + }, + "eventId": { + "description": "The eventId for the round trip from request to response.", + "maxLength": 256, + "type": "string", + "readOnly": true + } + } + }, + "RankResponse": { + "description": "Returns which action to use as rewardActionId, and additional information about each action as a result of a Rank request.", + "type": "object", + "properties": { + "ranking": { + "description": "The calculated ranking for the current request.", + "type": "array", + "items": { + "$ref": "#/definitions/RankedAction" + }, + "readOnly": true + }, + "eventId": { + "description": "The eventId for the round trip from request to response.", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "rewardActionId": { + "description": "The action chosen by the Personalizer service.\r\nThis is the action your application should display, and for which to report the reward.\r\nThis might not be the first found in 'ranking'.", + "maxLength": 256, + "type": "string", + "readOnly": true + } + } + }, + "RankedAction": { + "description": "A ranked action with its resulting probability.", + "type": "object", + "properties": { + "id": { + "description": "Id of the action", + "maxLength": 256, + "type": "string", + "readOnly": true + }, + "probability": { + "format": "float", + "description": "Probability of the action", + "maximum": 1, + "minimum": 0, + "type": "number", + "readOnly": true + } + } + }, + "ServiceStatus": { + "type": "object", + "properties": { + "service": { + "type": "string" + }, + "apiStatus": { + "type": "string" + }, + "apiStatusMessage": { + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "apim_key": { + "name": "Ocp-Apim-Subscription-Key", + "description": "The secret key for your Azure Cognitive Services subscription.", + "in": "header", + "type": "apiKey" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "tags": [ + { + "name": "ConfigurationsV1Dot1Preview1", + "description": "Manages configuration operations." + }, + { + "name": "EvaluationsV1Dot1Preview1", + "description": "Manages counterfactual evaluation operations." + }, + { + "name": "MultiSlotEvents", + "description": "Manages multi-slot event operations." + }, + { + "name": "MultiSlotRank", + "description": "Manages multi-slot ranking operations." + }, + { + "name": "Events", + "description": "Manages event operations." + }, + { + "name": "Rank", + "description": "Manages ranking operations." + }, + { + "name": "LogsV1Dot1Preview2", + "description": "Manages reinforcement learning logs." + }, + { + "name": "ModelV1Dot1Preview3", + "description": "Manages reinforcement learning configuration operations." + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Create.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Create.json new file mode 100644 index 000000000000..a6f95eb0a03f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "evaluation": { + "enableOfflineExperimentation": true, + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "policies": [ + { + "name": "Custom learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + } + ] + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "201": { + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "pending", + "policyResults": [ + { + "name": "Custom learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5", + "policySource": "Online" + } + ], + "featureImportance": [], + "evaluationType": "Manual", + "optimalPolicy": "", + "creationTime": "2019-01-20T00:00:00Z" + }, + "headers": { + "Location": "{endpoint}/personalizer/v1.1-preview.3/evaluations/{evaluationId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Delete.json new file mode 100644 index 000000000000..854c1724f3d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "evaluationId": "id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Get.json new file mode 100644 index 000000000000..43a4c739528e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "evaluationId": "id" + }, + "responses": { + "200": { + "body": { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "completed", + "policyResults": [ + { + "name": "Custom learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5", + "policySource": "Custom", + "summary": [ + { + "timeStamp": "2018-12-19T00:00:00Z", + "ipsEstimatorNumerator": 0, + "ipsEstimatorDenominator": 170, + "snipsEstimatorDenominator": 308.25, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 64, + "sumOfSquares": 0, + "confidenceInterval": 0, + "averageReward": 0 + }, + { + "timeStamp": "2018-12-19T00:05:00Z", + "ipsEstimatorNumerator": 2.2, + "ipsEstimatorDenominator": 196, + "snipsEstimatorDenominator": 193.761, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 68, + "sumOfSquares": 2.424, + "confidenceInterval": 0.015529361, + "averageReward": 0.01122449 + } + ], + "totalSummary": { + "timeStamp": "2019-01-19T00:00:00Z", + "ipsEstimatorNumerator": 22.2, + "ipsEstimatorDenominator": 1906, + "snipsEstimatorDenominator": 1993.761, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 68, + "sumOfSquares": 2.484, + "confidenceInterval": 0.0015344538, + "averageReward": 0.011647429 + } + } + ], + "featureImportance": [ + [ + "f1", + "f2" + ], + [ + "f3", + "f4" + ] + ], + "evaluationType": "Manual", + "optimalPolicy": "Custom learning settings 1", + "creationTime": "2019-01-20T00:00:00Z" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_List.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_List.json new file mode 100644 index 000000000000..8cb556c966ce --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Evaluations_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": [ + { + "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "name": "myFirstEvaluation", + "startTime": "2018-11-19T00:00:00Z", + "endTime": "2018-12-19T00:00:00Z", + "status": "completed", + "policyResults": [ + { + "name": "Custom learning settings 1", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5", + "policySource": "Online", + "totalSummary": { + "timeStamp": "2018-12-19T00:00:00Z", + "ipsEstimatorNumerator": 18, + "ipsEstimatorDenominator": 36, + "snipsEstimatorDenominator": 1, + "aggregateTimeWindow": "PT0S", + "nonZeroProbability": 1.1, + "sumOfSquares": 12.28, + "confidenceInterval": 0.100001775, + "averageReward": 0.5 + } + } + ], + "featureImportance": [], + "evaluationType": "Manual", + "optimalPolicy": "Custom learning settings 1", + "creationTime": "2019-01-19T00:00:00Z" + }, + { + "id": "21d03972-9130-4be9-8c8b-8ac3ec9b9dd1", + "name": "mySecondEvaluation", + "startTime": "2018-12-19T00:00:00Z", + "endTime": "2019-01-19T00:00:00Z", + "status": "pending", + "policyResults": [], + "featureImportance": [], + "evaluationType": "Manual", + "optimalPolicy": "", + "creationTime": "2019-01-19T00:00:00Z" + } + ], + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Activate.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Activate.json new file mode 100644 index 000000000000..47ac1946d68e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Activate.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "eventId": "id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Reward.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Reward.json new file mode 100644 index 000000000000..896eec725203 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Events_Reward.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "reward": { + "value": 1 + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "eventId": "id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Delete.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Delete.json new file mode 100644 index 000000000000..b8952c3d0f60 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_GetProperties.json new file mode 100644 index 000000000000..44b8656a01dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_GetProperties.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "dateRange": { + "from": "2019-01-18T16:00:00-08:00", + "to": "2019-02-18T16:00:00-08:00" + } + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Interactions.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Interactions.json new file mode 100644 index 000000000000..0c4f117e5428 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Interactions.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "body": "id", + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Observations.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Observations.json new file mode 100644 index 000000000000..0c4f117e5428 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Log_Observations.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "body": "id", + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Get.json new file mode 100644 index 000000000000..60b30ff52f95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Get.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "signed": false, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": "", + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_GetProperties.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_GetProperties.json new file mode 100644 index 000000000000..2ed31c250914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_GetProperties.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "creationTime": "2019-01-18T16:00:00-08:00", + "lastModifiedTime": "2019-01-18T16:00:00-08:00" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Import.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Import.json new file mode 100644 index 000000000000..0c4f117e5428 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Import.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "body": "id", + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Reset.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Reset.json new file mode 100644 index 000000000000..b8952c3d0f60 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Model_Reset.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Activate.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Activate.json new file mode 100644 index 000000000000..47ac1946d68e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Activate.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "eventId": "id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Reward.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Reward.json new file mode 100644 index 000000000000..c0aa2cb77c2d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlotEvents_Reward.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "body": { + "reward": [ + { + "slotId": "Heroposition", + "value": 0.5 + }, + { + "slotId": "SideBar", + "value": 0.6 + } + ] + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}", + "eventId": "id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlot_Rank.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlot_Rank.json new file mode 100644 index 000000000000..20e78c77ad8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/MultiSlot_Rank.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "body": { + "contextFeatures": [ + { + "user": { + "profileType": "AnonymousUser", + "latLong": "47.6,-122.1" + } + }, + { + "environment": { + "dayOfMonth": "28", + "monthOfYear": "8", + "weather": "Sunny" + } + }, + { + "device": { + "mobile": true, + "windows": true + } + }, + { + "recentActivity": { + "itemsInCart": 3 + } + } + ], + "actions": [ + { + "id": "NewsArticle", + "features": [ + { + "type": "News" + } + ] + }, + { + "id": "SportsArticle", + "features": [ + { + "type": "Sports" + } + ] + }, + { + "id": "EntertainmentArticle", + "features": [ + { + "type": "Entertainment" + } + ] + } + ], + "slots": [ + { + "id": "Main Article", + "features": [ + { + "size": "Large", + "position": "Top Middle" + } + ], + "excludedActions": [ + "SportsArticle" + ], + "baselineAction": "EntertainmentArticle" + }, + { + "id": "Side Bar", + "features": [ + { + "size": "Small" + } + ], + "baselineAction": "NewsArticle" + } + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "deferActivation": false + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "201": { + "body": { + "slots": [ + { + "id": "Main Article", + "rewardActionId": "EntertainmentArticle" + }, + { + "id": "Side Bar", + "rewardActionId": "SportsArticle" + } + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Get.json new file mode 100644 index 000000000000..b0e96b20f6cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Reset.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Reset.json new file mode 100644 index 000000000000..b0e96b20f6cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Reset.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Update.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Update.json new file mode 100644 index 000000000000..5c1eb593c078 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Policy_Update.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "policy": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "name": "myPersonalizer", + "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Rank.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Rank.json new file mode 100644 index 000000000000..a8dea3e1524a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/Rank.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "rankRequest": { + "contextFeatures": [ + { + "user": { + "profileType": "AnonymousUser", + "latLong": "47.6,-122.1" + } + }, + { + "environment": { + "dayOfMonth": "28", + "monthOfYear": "8", + "weather": "Sunny" + } + }, + { + "device": { + "mobile": true, + "windows": true + } + }, + { + "recentActivity": { + "itemsInCart": 3 + } + } + ], + "actions": [ + { + "id": "NewsArticle", + "features": [ + { + "type": "News" + } + ] + }, + { + "id": "SportsArticle", + "features": [ + { + "type": "Sports" + } + ] + }, + { + "id": "EntertainmentArticle", + "features": [ + { + "type": "Entertainment" + } + ] + } + ], + "excludedActions": [ + "SportsArticle" + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "deferActivation": false + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "201": { + "body": { + "ranking": [ + { + "id": "EntertainmentArticle", + "probability": 0.8 + }, + { + "id": "SportsArticle", + "probability": 0 + }, + { + "id": "NewsArticle", + "probability": 0.2 + } + ], + "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10", + "rewardActionId": "EntertainmentArticle" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_ApplyFromEvaluation.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_ApplyFromEvaluation.json new file mode 100644 index 000000000000..eac3177fd445 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_ApplyFromEvaluation.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "body": { + "evaluationId": "b58c6d92-b727-48c1-9487-4be2782c9e0a", + "policyName": "online" + }, + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Get.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Get.json new file mode 100644 index 000000000000..5d74872c99c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "body": { + "rewardWaitTime": "PT10M", + "defaultReward": 0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7, + "lastConfigurationEditDate": "2019-01-19T00:00:00Z", + "learningMode": "Online", + "isAutoOptimizationEnabled": true, + "autoOptimizationFrequency": "P7D", + "autoOptimizationStartDate": "2019-01-19T00:00:00Z" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Update.json b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Update.json new file mode 100644 index 000000000000..748822296997 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Personalizer/preview/v1.1-preview.3/examples/ServiceConfiguration_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "config": { + "rewardWaitTime": "PT10M", + "defaultReward": 0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7, + "learningMode": "Online", + "isAutoOptimizationEnabled": true, + "autoOptimizationFrequency": "P7D", + "autoOptimizationStartDate": "2019-01-19T00:00:00Z" + }, + "Ocp-Apim-Subscription-Key": "{API key}", + "Endpoint": "{Endpoint}" + }, + "responses": { + "200": { + "body": { + "rewardWaitTime": "PT10M", + "defaultReward": 0, + "rewardAggregation": "earliest", + "explorationPercentage": 0.2, + "modelExportFrequency": "PT5M", + "logMirrorEnabled": true, + "logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature", + "logRetentionDays": 7, + "lastConfigurationEditDate": "2019-01-19T00:00:00Z", + "learningMode": "Online", + "isAutoOptimizationEnabled": true, + "autoOptimizationFrequency": "P7D", + "autoOptimizationStartDate": "2019-01-19T00:00:00Z" + }, + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/Personalizer/readme.md b/specification/cognitiveservices/data-plane/Personalizer/readme.md index cf33e5ecdf36..56ad2e97fe68 100644 --- a/specification/cognitiveservices/data-plane/Personalizer/readme.md +++ b/specification/cognitiveservices/data-plane/Personalizer/readme.md @@ -44,6 +44,14 @@ input-file: - preview/v1.1-preview.2/Personalizer.json ``` +### Release 1.1-Preview.3 +These settings apply only when `--tag=release_1_1_preview.3` is specified on the command line. + +``` yaml $(tag) == 'release_1_1_preview.3' +input-file: + - preview/v1.1-preview.3/Personalizer.json +``` + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. diff --git a/specification/communication/data-plane/NetworkTraversal/readme.md b/specification/communication/data-plane/NetworkTraversal/readme.md index 1e19106b9ffd..d8e5e19406b2 100644 --- a/specification/communication/data-plane/NetworkTraversal/readme.md +++ b/specification/communication/data-plane/NetworkTraversal/readme.md @@ -58,15 +58,6 @@ input-file: - preview/2021-10-08-preview/CommunicationNetworkTraversal.json ``` -### Tag: package-2022-02-01 - -These settings apply only when `--tag=package-2022-02-01` is specified on the command line. - -```yaml $(tag) == 'package-2022-02-01' -input-file: - - stable/2022-02-01/CommunicationNetworkTraversal.json -``` - --- # Code Generation diff --git a/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/CommunicationNetworkTraversal.json b/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/CommunicationNetworkTraversal.json deleted file mode 100644 index 062d64ae1eed..000000000000 --- a/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/CommunicationNetworkTraversal.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "CommunicationNetworkTraversalClient", - "description": "Azure Communication Network Traversal Service", - "version": "2022-02-01" - }, - "paths": { - "/networkTraversal/:issueRelayConfiguration": { - "post": { - "tags": [ - "Turn" - ], - "summary": "Issue a configuration for an STUN/TURN server.", - "operationId": "CommunicationNetworkTraversal_IssueRelayConfiguration", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "description": "Optional request for providing the id and/or route type for the returned relay configuration.", - "in": "body", - "name": "body", - "schema": { - "$ref": "#/definitions/CommunicationRelayConfigurationRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CommunicationRelayConfiguration" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "Issue Relay Configuration": { - "$ref": "./examples/IssueRelayConfiguration.json" - } - } - } - } - }, - "definitions": { - "CommunicationRelayConfigurationRequest": { - "description": "Request for a CommunicationRelayConfiguration.", - "type": "object", - "properties": { - "id": { - "description": "An identity to be associated with telemetry for data relayed using the returned credentials. Must be an existing ACS user identity. If not provided, the telemetry will not contain an associated identity value.", - "type": "string" - }, - "routeType": { - "description": "Filter the routing methodology returned. If not provided, will return all route types in separate ICE servers.", - "$ref": "#/definitions/RouteType" - } - } - }, - "CommunicationIceServer": { - "description": "An instance of a STUN/TURN server with credentials to be used for ICE negotiation.", - "required": [ - "credential", - "urls", - "username", - "routeType" - ], - "type": "object", - "properties": { - "urls": { - "description": "List of STUN/TURN server URLs.", - "type": "array", - "items": { - "type": "string" - } - }, - "username": { - "description": "User account name which uniquely identifies the credentials.", - "type": "string" - }, - "credential": { - "description": "Credential for the server.", - "type": "string" - }, - "routeType": { - "$ref": "#/definitions/RouteType" - } - } - }, - "CommunicationRelayConfiguration": { - "description": "A relay configuration containing the STUN/TURN URLs and credentials.", - "required": [ - "expiresOn", - "iceServers" - ], - "type": "object", - "properties": { - "expiresOn": { - "format": "date-time", - "description": "The date for which the username and credentials are not longer valid. Will be 48 hours from request time.", - "type": "string" - }, - "iceServers": { - "description": "An array representing the credentials and the STUN/TURN server URLs for use in ICE negotiations.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIceServer" - } - } - } - }, - "RouteType": { - "description": "The routing methodology to where the ICE server will be located from the client. \"any\" will have higher reliability while \"nearest\" will have lower latency. It is recommended to default to use the \"any\" routing method unless there are specific scenarios which minimizing latency is critical.", - "enum": [ - "any", - "nearest" - ], - "type": "string", - "x-ms-enum": { - "name": "RouteType", - "modelAsString": true - } - } - }, - "parameters": { - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "Version of API to invoke.", - "required": true, - "enum": [ - "2022-02-01" - ], - "type": "string" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "name": "endpoint", - "description": "The communication resource, for example https://my-resource.communication.azure.com", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - ] - } -} diff --git a/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/examples/IssueRelayConfiguration.json b/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/examples/IssueRelayConfiguration.json deleted file mode 100644 index 3264ddc9e800..000000000000 --- a/specification/communication/data-plane/NetworkTraversal/stable/2022-02-01/examples/IssueRelayConfiguration.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2022-02-01", - "content-type": "application/json", - "body": { - "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081" - }, - "endpoint": "https://my-resource.communication.azure.com" - }, - "responses": { - "200": { - "body": { - "expiresOn": "2022-01-10T21:39:39.3244584+00:00", - "iceServers": [ - { - "urls": [ - "turn:131.107.255.255:3478", - "stun:131.107.255.255:3478" - ], - "username": "AgAAJNOeygwB1uVGvuwAVMHV4PLhYDgY66Fg1dUZvQ4AAAAEhXrhc8uJFjOK8lxEsZk3KIpWxc0=", - "credential": "9rl8ablFWj6/aqSuPLgLykLZKqw=", - "routeType": "any" - } - ] - } - } - } -} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json index 44de229cd1d6..21a6ed40b08c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/cloudService.json @@ -45,12 +45,6 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, @@ -59,6 +53,12 @@ }, "204": { "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -116,17 +116,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/RoleInstance" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -171,17 +171,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/RoleInstanceInstanceView" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -233,17 +233,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/RoleInstanceListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -291,17 +291,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -347,17 +347,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -403,17 +403,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -462,18 +462,18 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "format": "binary", "type": "file" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -513,17 +513,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudServiceRole" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -561,17 +561,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudServiceRoleListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -622,12 +622,6 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { @@ -639,6 +633,12 @@ "schema": { "$ref": "#/definitions/CloudService" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -694,17 +694,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudService" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -743,12 +743,6 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, @@ -757,6 +751,12 @@ }, "204": { "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -795,17 +795,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudService" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -845,17 +845,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudServiceInstanceView" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -881,17 +881,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudServiceListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -927,17 +927,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/CloudServiceListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -980,17 +980,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1031,17 +1031,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1090,17 +1090,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1149,17 +1149,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1208,17 +1208,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1267,17 +1267,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1334,17 +1334,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK" }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true, @@ -1391,17 +1391,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateDomain" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1441,17 +1441,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateDomainListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1494,17 +1494,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/OSVersion" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1537,17 +1537,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/OSVersionListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1590,17 +1590,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/OSFamily" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1633,17 +1633,17 @@ } ], "responses": { - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, "200": { "description": "OK", "schema": { "$ref": "#/definitions/OSFamilyListResult" } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-examples": { @@ -1699,7 +1699,11 @@ "type": "array", "items": { "$ref": "#/definitions/ApiErrorBase" - } + }, + "x-ms-identifiers": [ + "message", + "target" + ] }, "innererror": { "$ref": "#/definitions/InnerError", @@ -1834,6 +1838,7 @@ "items": { "$ref": "#/definitions/ResourceInstanceViewStatus" }, + "x-ms-identifiers": [], "readOnly": true } } @@ -2019,7 +2024,10 @@ "type": "array", "items": { "$ref": "#/definitions/CloudServiceRoleProfileProperties" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -2046,7 +2054,10 @@ "type": "array", "items": { "$ref": "#/definitions/CloudServiceVaultCertificate" - } + }, + "x-ms-identifiers": [ + "certificateUrl" + ] } } }, @@ -2059,7 +2070,10 @@ "type": "array", "items": { "$ref": "#/definitions/CloudServiceVaultSecretGroup" - } + }, + "x-ms-identifiers": [ + "sourceVault/id" + ] } } }, @@ -2106,7 +2120,10 @@ "type": "array", "items": { "$ref": "#/definitions/LoadBalancerFrontendIPConfiguration" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "required": [ @@ -2234,7 +2251,10 @@ "type": "array", "items": { "$ref": "#/definitions/Extension" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -2365,6 +2385,7 @@ "items": { "$ref": "#/definitions/StatusCodeCount" }, + "x-ms-identifiers": [], "readOnly": true } } @@ -2394,6 +2415,7 @@ "items": { "$ref": "#/definitions/ResourceInstanceViewStatus" }, + "x-ms-identifiers": [], "readOnly": true } } @@ -2592,6 +2614,9 @@ "items": { "$ref": "#/definitions/OSVersionPropertiesBase" }, + "x-ms-identifiers": [ + "version" + ], "readOnly": true } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/runCommands.json index 09fef5bae540..80f3608b48a6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/runCommands.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-03-01/runCommands.json @@ -959,6 +959,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The run command parameters." } }, @@ -1052,6 +1055,10 @@ "items": { "$ref": "#/definitions/RunCommandParameterDefinition" }, + "x-ms-identifiers": [ + "name", + "type" + ], "description": "The parameters used by the script." } }, @@ -1121,6 +1128,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "Run command operation response." } } @@ -1209,6 +1217,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The parameters used by the script." }, "protectedParameters": { @@ -1216,6 +1227,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The parameters used by the script." }, "asyncExecution": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/communityGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/communityGallery.json index 711cf2ecd43e..905915f4ffd2 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/communityGallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/communityGallery.json @@ -284,6 +284,9 @@ "items": { "$ref": "#/definitions/GalleryImageFeature" }, + "x-ms-identifiers": [ + "name" + ], "description": "A list of gallery image features." }, "purchasePlan": { @@ -432,6 +435,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/sharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/sharedGallery.json index 118c66bc77b3..8da93b87410c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/sharedGallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/sharedGallery.json @@ -430,6 +430,9 @@ "items": { "$ref": "#/definitions/SharedGallery" }, + "x-ms-identifiers": [ + "name" + ], "description": "A list of shared galleries." }, "nextLink": { @@ -458,6 +461,7 @@ "items": { "$ref": "#/definitions/SharedGalleryImage" }, + "x-ms-identifiers": [], "description": "A list of shared gallery images." }, "nextLink": { @@ -540,6 +544,9 @@ "items": { "$ref": "#/definitions/GalleryImageFeature" }, + "x-ms-identifiers": [ + "name" + ], "description": "A list of gallery image features." }, "purchasePlan": { @@ -651,6 +658,7 @@ "items": { "$ref": "#/definitions/SharedGalleryImageVersion" }, + "x-ms-identifiers": [], "description": "A list of shared gallery images versions." }, "nextLink": { @@ -707,6 +715,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/skus.json index 464b5e4cbb13..e02c038d486d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/skus.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-07-01/skus.json @@ -175,6 +175,9 @@ "items": { "$ref": "#/definitions/ResourceSkuCapabilities" }, + "x-ms-identifiers": [ + "name" + ], "description": "A list of capabilities that are available for the SKU in the specified list of zones." } }, @@ -275,6 +278,9 @@ "items": { "$ref": "#/definitions/ResourceSkuLocationInfo" }, + "x-ms-identifiers": [ + "location" + ], "description": "A list of locations and availability zones in those locations where the SKU is available." }, "apiVersions": { @@ -291,6 +297,7 @@ "items": { "$ref": "#/definitions/ResourceSkuCosts" }, + "x-ms-identifiers": [], "description": "Metadata for retrieving price info." }, "capabilities": { @@ -299,6 +306,9 @@ "items": { "$ref": "#/definitions/ResourceSkuCapabilities" }, + "x-ms-identifiers": [ + "name" + ], "description": "A name value pair to describe the capability." }, "restrictions": { @@ -307,6 +317,7 @@ "items": { "$ref": "#/definitions/ResourceSkuRestrictions" }, + "x-ms-identifiers": [], "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." } }, @@ -333,6 +344,9 @@ "items": { "$ref": "#/definitions/ResourceSkuZoneDetails" }, + "x-ms-identifiers": [ + "name" + ], "description": "Details of capabilities available to a SKU in specific zones." }, "extendedLocations": { @@ -386,6 +400,10 @@ "items": { "$ref": "#/definitions/ResourceSku" }, + "x-ms-identifiers": [ + "name", + "resourceType" + ], "description": "The list of skus available for the subscription." }, "nextLink": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json index ab4f5933d5ca..f6e60a1f664a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-08-01/disk.json @@ -2180,6 +2180,9 @@ "items": { "$ref": "#/definitions/ShareInfoElement" }, + "x-ms-identifiers": [ + "vmUri" + ], "description": "Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." }, "networkAccessPolicy": { @@ -2356,6 +2359,9 @@ "items": { "$ref": "#/definitions/KeyForDiskEncryptionSet" }, + "x-ms-identifiers": [ + "sourceVault/id" + ], "description": "A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation." }, "provisioningState": { @@ -2391,6 +2397,9 @@ "items": { "$ref": "#/definitions/EncryptionSettingsElement" }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], "description": "A collection of encryption settings, one for each disk volume." }, "encryptionSettingsVersion": { @@ -3614,6 +3623,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json index f78cde43939c..6ea8b84eaf44 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json @@ -1827,6 +1827,7 @@ "items": { "$ref": "#/definitions/SharingProfileGroup" }, + "x-ms-identifiers": [], "description": "A list of sharing profile groups." }, "communityGalleryInfo": { @@ -1920,6 +1921,9 @@ "items": { "$ref": "#/definitions/RegionalSharingStatus" }, + "x-ms-identifiers": [ + "region" + ], "description": "Summary of all regional sharing status." } }, @@ -2263,6 +2267,9 @@ "items": { "$ref": "#/definitions/GalleryImageFeature" }, + "x-ms-identifiers": [ + "name" + ], "description": "A list of gallery image features." } }, @@ -2430,6 +2437,9 @@ "items": { "$ref": "#/definitions/TargetRegion" }, + "x-ms-identifiers": [ + "name" + ], "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." }, "replicaCount": { @@ -2482,6 +2492,10 @@ "items": { "$ref": "#/definitions/GalleryTargetExtendedLocation" }, + "x-ms-identifiers": [ + "name", + "extendedLocation/name" + ], "description": "The target extended locations where the Image Version is going to be replicated to. This property is updatable." } }, @@ -2587,6 +2601,9 @@ "items": { "$ref": "#/definitions/DataDiskImageEncryption" }, + "x-ms-identifiers": [ + "lun" + ], "description": "A list of encryption specifications for data disk images." } }, @@ -2702,6 +2719,9 @@ "items": { "$ref": "#/definitions/GalleryDataDiskImage" }, + "x-ms-identifiers": [ + "lun" + ], "description": "A list of data disk images." } }, @@ -2796,6 +2816,9 @@ "items": { "$ref": "#/definitions/RegionalReplicationStatus" }, + "x-ms-identifiers": [ + "region" + ], "description": "This is a summary of replication status for each region." } }, @@ -2948,6 +2971,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { @@ -3084,6 +3111,7 @@ "items": { "$ref": "#/definitions/SharingProfileGroup" }, + "x-ms-identifiers": [], "description": "A list of sharing profile groups." } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json index 1e8a59ffdc11..ad1df0ff9e54 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/compute.json @@ -9829,6 +9829,9 @@ "items": { "$ref": "#/definitions/RestorePointSourceVMDataDisk" }, + "x-ms-identifiers": [ + "lun" + ], "description": "Gets the data disks of the VM captured at the time of the restore point creation." } }, @@ -9936,6 +9939,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -10030,6 +10034,9 @@ "items": { "$ref": "#/definitions/ComputeOperationValue" }, + "x-ms-identifiers": [ + "name" + ], "description": "The list of compute operations" } }, @@ -10187,6 +10194,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -10366,6 +10374,9 @@ "items": { "$ref": "#/definitions/DedicatedHostInstanceViewWithName" }, + "x-ms-identifiers": [ + "name" + ], "description": "List of instance view of the dedicated hosts under the dedicated host group." } } @@ -10496,6 +10507,7 @@ "items": { "$ref": "#/definitions/DedicatedHostAllocatableVM" }, + "x-ms-identifiers": [], "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." } }, @@ -10517,6 +10529,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -10653,6 +10666,9 @@ "items": { "$ref": "#/definitions/CapacityReservationInstanceViewWithName" }, + "x-ms-identifiers": [ + "name" + ], "readOnly": true, "description": "List of instance view of the capacity reservations under the capacity reservation group." } @@ -10754,6 +10770,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -11019,6 +11036,9 @@ "items": { "$ref": "#/definitions/VirtualMachineSize" }, + "x-ms-identifiers": [ + "name" + ], "description": "The list of virtual machine sizes." } }, @@ -11124,6 +11144,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." }, "statuses": { @@ -11131,6 +11152,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -11466,6 +11488,9 @@ "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualMachineSoftwarePatchProperties" }, + "x-ms-identifiers": [ + "patchId" + ], "description": "The list of patches that have been detected as available for installation." }, "error": { @@ -11679,6 +11704,9 @@ "x-ms-client-flatten": true, "$ref": "#/definitions/PatchInstallationDetail" }, + "x-ms-identifiers": [ + "patchId" + ], "description": "The patches that were installed during the operation." }, "startDateTime": { @@ -11835,7 +11863,10 @@ "type": "array", "items": { "$ref": "#/definitions/DataDiskImage" - } + }, + "x-ms-identifiers": [ + "lun" + ] }, "automaticOSUpgradeProperties": { "$ref": "#/definitions/AutomaticOSUpgradeProperties" @@ -11851,7 +11882,10 @@ "type": "array", "items": { "$ref": "#/definitions/VirtualMachineImageFeature" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "description": "Describes the properties of a Virtual Machine Image." @@ -11930,6 +11964,7 @@ "items": { "$ref": "#/definitions/Usage" }, + "x-ms-identifiers": [], "description": "The list of compute resource usages." }, "nextLink": { @@ -11997,6 +12032,7 @@ "type": "object", "description": "resource item" }, + "x-ms-identifiers": [], "description": "a list of resource items of the captured virtual machine" } }, @@ -12642,6 +12678,9 @@ "items": { "$ref": "#/definitions/DataDisk" }, + "x-ms-identifiers": [ + "lun" + ], "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." } }, @@ -12719,6 +12758,9 @@ "items": { "$ref": "#/definitions/VMGalleryApplication" }, + "x-ms-identifiers": [ + "packageReferenceId" + ], "description": "Specifies the gallery applications that should be made available to the VM/VMSS" } }, @@ -12818,6 +12860,7 @@ "items": { "$ref": "#/definitions/WinRMListener" }, + "x-ms-identifiers": [], "description": "The list of Windows Remote Management listeners" } }, @@ -12842,6 +12885,7 @@ "items": { "$ref": "#/definitions/AdditionalUnattendContent" }, + "x-ms-identifiers": [], "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." }, "patchSettings": { @@ -12875,6 +12919,9 @@ "items": { "$ref": "#/definitions/SshPublicKey" }, + "x-ms-identifiers": [ + "path" + ], "description": "The list of SSH public keys used to authenticate with linux based VMs." } }, @@ -12925,6 +12972,9 @@ "items": { "$ref": "#/definitions/VaultCertificate" }, + "x-ms-identifiers": [ + "certificateUrl" + ], "description": "The list of key vault references in SourceVault which contain certificates." } }, @@ -12961,6 +13011,9 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, + "x-ms-identifiers": [ + "sourceVault/id" + ], "description": "Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "allowExtensionOperations": { @@ -13088,6 +13141,7 @@ "items": { "$ref": "#/definitions/VirtualMachineIpTag" }, + "x-ms-identifiers": [], "description": "The list of IP tags associated with the public IP address." }, "publicIPPrefix": { @@ -13290,6 +13344,9 @@ "items": { "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfiguration" }, + "x-ms-identifiers": [ + "name" + ], "description": "Specifies the IP configurations of the network interface." }, "dscpConfiguration": { @@ -13342,6 +13399,9 @@ "items": { "$ref": "#/definitions/VirtualMachineNetworkInterfaceConfiguration" }, + "x-ms-identifiers": [ + "name" + ], "description": "Specifies the networking configurations that will be used to create the virtual machine networking resources." } }, @@ -13432,6 +13492,7 @@ "items": { "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" }, + "x-ms-identifiers": [], "description": "The virtual machine extension handler instance view." }, "statuses": { @@ -13439,6 +13500,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -13455,6 +13517,9 @@ "items": { "$ref": "#/definitions/DiskEncryptionSettings" }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" }, "statuses": { @@ -13462,6 +13527,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -13636,6 +13702,9 @@ "items": { "$ref": "#/definitions/DiskInstanceView" }, + "x-ms-identifiers": [ + "name" + ], "description": "The virtual machine disk information." }, "extensions": { @@ -13643,6 +13712,10 @@ "items": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView" }, + "x-ms-identifiers": [ + "name", + "type" + ], "description": "The extensions information." }, "vmHealth": { @@ -13664,6 +13737,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." }, "patchStatus": { @@ -14143,6 +14217,9 @@ "items": { "$ref": "#/definitions/ImageDataDisk" }, + "x-ms-identifiers": [ + "lun" + ], "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." }, "zoneResilient": { @@ -14305,6 +14382,9 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, + "x-ms-identifiers": [ + "sourceVault/id" + ], "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." }, "allowExtensionOperations": { @@ -14333,6 +14413,9 @@ "items": { "$ref": "#/definitions/VaultSecretGroup" }, + "x-ms-identifiers": [ + "sourceVault/id" + ], "description": "The List of certificates for addition to the VM." } }, @@ -14512,6 +14595,10 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" }, + "x-ms-identifiers": [ + "name", + "lun" + ], "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." } }, @@ -14532,6 +14619,10 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" }, + "x-ms-identifiers": [ + "name", + "lun" + ], "description": "The data disks." } }, @@ -14922,6 +15013,7 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetIpTag" }, + "x-ms-identifiers": [], "description": "The list of IP tags associated with the public IP address." }, "publicIPPrefix": { @@ -15546,6 +15638,7 @@ "items": { "$ref": "#/definitions/VirtualMachineStatusCodeCount" }, + "x-ms-identifiers": [], "description": "The extensions information." } }, @@ -15564,6 +15657,7 @@ "items": { "$ref": "#/definitions/VirtualMachineStatusCodeCount" }, + "x-ms-identifiers": [], "description": "The extensions information." } }, @@ -15613,6 +15707,9 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" }, + "x-ms-identifiers": [ + "name" + ], "description": "The extensions information." }, "statuses": { @@ -15620,6 +15717,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." }, "orchestrationServices": { @@ -15628,6 +15726,9 @@ "items": { "$ref": "#/definitions/OrchestrationServiceSummary" }, + "x-ms-identifiers": [ + "serviceName" + ], "description": "The orchestration services information." } }, @@ -15734,6 +15835,10 @@ "items": { "$ref": "#/definitions/VirtualMachineScaleSetSku" }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], "description": "The list of skus available for the virtual machine scale set." }, "nextLink": { @@ -15871,6 +15976,10 @@ "items": { "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" }, + "x-ms-identifiers": [ + "type", + "location" + ], "description": "The list of OS upgrades performed on the virtual machine scale set." }, "nextLink": { @@ -16034,6 +16143,9 @@ "items": { "$ref": "#/definitions/DiskInstanceView" }, + "x-ms-identifiers": [ + "name" + ], "description": "The disks information." }, "extensions": { @@ -16041,6 +16153,10 @@ "items": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView" }, + "x-ms-identifiers": [ + "name", + "type" + ], "description": "The extensions information." }, "vmHealth": { @@ -16057,6 +16173,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." }, "assignedHost": { @@ -16306,6 +16423,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { @@ -16671,7 +16792,8 @@ "type": "array", "items": { "$ref": "#/definitions/InstanceViewStatus" - } + }, + "x-ms-identifiers": [] } }, "description": "The status of virtual machine patch operations." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/runCommands.json index 940900927102..5e9a4f366a99 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/runCommands.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2021-11-01/runCommands.json @@ -959,6 +959,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The run command parameters." } }, @@ -1052,6 +1055,10 @@ "items": { "$ref": "#/definitions/RunCommandParameterDefinition" }, + "x-ms-identifiers": [ + "name", + "type" + ], "description": "The parameters used by the script." } }, @@ -1121,6 +1128,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "Run command operation response." } } @@ -1176,6 +1184,7 @@ "items": { "$ref": "#/definitions/InstanceViewStatus" }, + "x-ms-identifiers": [], "description": "The resource status information." } }, @@ -1209,6 +1218,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The parameters used by the script." }, "protectedParameters": { @@ -1216,6 +1228,9 @@ "items": { "$ref": "#/definitions/RunCommandInputParameter" }, + "x-ms-identifiers": [ + "name" + ], "description": "The parameters used by the script." }, "asyncExecution": { @@ -1350,6 +1365,10 @@ "items": { "$ref": "#/definitions/ApiErrorBase" }, + "x-ms-identifiers": [ + "message", + "target" + ], "description": "The Api error details" }, "innererror": { diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json index da5066749b97..bf60b61c0f24 100644 --- a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/confidentialledger.json @@ -530,7 +530,7 @@ "description": "Cert based security principal with Ledger RoleName", "properties": { "cert": { - "description": "Base64 encoded public key of the user cert (.pem or .cer)", + "description": "Public key of the user cert (.pem or .cer)", "type": "string" }, "ledgerRoleName": { diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json index 96e423cee57f..58a2ed04ad60 100644 --- a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/confidentialledger.json @@ -412,7 +412,7 @@ } }, "definitions": { - "Location": { + "ResourceLocation": { "description": "Location of the ARM Resource", "type": "object", "properties": { @@ -481,6 +481,9 @@ "items": { "$ref": "#/definitions/ResourceProviderOperationDefinition" }, + "x-ms-identifiers": [ + "name" + ], "readOnly": true }, "nextLink": { @@ -578,7 +581,7 @@ "description": "Cert based security principal with Ledger RoleName", "properties": { "cert": { - "description": "Base64 encoded public key of the user cert (.pem or .cer)", + "description": "Public key of the user cert (.pem or .cer)", "type": "string" }, "ledgerRoleName": { @@ -642,14 +645,18 @@ "type": "array", "items": { "$ref": "#/definitions/AADBasedSecurityPrincipal" - } + }, + "x-ms-identifiers": [ + "principalId" + ] }, "certBasedSecurityPrincipals": { "description": "Array of all cert based Security Principals.", "type": "array", "items": { "$ref": "#/definitions/CertBasedSecurityPrincipal" - } + }, + "x-ms-identifiers": [] } } }, @@ -661,7 +668,7 @@ "$ref": "#/definitions/Resource" }, { - "$ref": "#/definitions/Location" + "$ref": "#/definitions/ResourceLocation" }, { "$ref": "#/definitions/Tags" diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json index 75df24f7242e..0989499b1a4d 100644 --- a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Create.json @@ -16,7 +16,7 @@ ], "certBasedSecurityPrincipals": [ { - "cert": "MIIDBTCCAe2gAwIBAgIQXVogj9BAf49IpuOSIvztNDANBgkqhkiG9w0BAQsFADAtMSswKQYDVQQDEyJhY2NvdW50cy5hY2Nlc3Njb250cm9sLndpbmRvd3MubmV0MB4XDTIwMDMxNzAwMDAwMFoXDTI1MDMxNzAwMDAwMFowLTErMCkGA1UEAxMiYWNjb3VudHMuYWNjZXNzY29udHJvbC53aW5kb3dzLm5ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANfLmdz9yIDskpZzrMXiDeVlCs75ZunrzwzBW5lz7UxdBjHu7Q9iT32otlBp++LOwBcKsVjuQ0GUbulX0FLsfLjEeCe58ZtSn//+6VRFSScg7i+WvDwEUWELR+vMPtCGcXBTpILEnYbSMz0No4+Jpkc1lyMIfDP/KSeqojo74xfW4RKtAgv39uwZ5Yz2hZ/IcWOvaQqMXp1lqhXLFIRWbwjLYYUbmwGwYpQ6++Cml0ucQoMkgYT88HpA/fzXQlLgrHamr3eE/lVp26ZWwfGLAvkdNBabQRSrk8k/c6BmY1mYpUFZo+795PI16mAdp1ioEwH8I5osis+/BR5GhPpwiA8CAwEAAaMhMB8wHQYDVR0OBBYEFF8MDGklOGhGNVJvsHHRCaqtzexcMA0GCSqGSIb3DQEBCwUAA4IBAQCKkegw/mdpCVl1lOpgU4G9RT+1gtcPqZK9kpimuDggSJju6KUQlOCi5/lIH5DCzpjFdmG17TjWVBNve5kowmrhLzovY0Ykk7+6hYTBK8dNNSmd4SK7zY++0aDIuOzHP2Cur+kgFC0gez50tPzotLDtMmp40gknXuzltwJfezNSw3gLgljDsGGcDIXK3qLSYh44qSuRGwulcN2EJUZBI9tIxoODpaWHIN8+z2uZvf8JBYFjA3+n9FRQn51X16CTcjq4QRTbNVpgVuQuyaYnEtx0ZnDvguB3RjGSPIXTRBkLl2x7e8/6uAZ6tchw8rhcOtPsFgJuoJokGjvcUSR/6Eqd", + "cert": "-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhcNMjEwMzE2MTgwNjExWhcNMjIwMzE2MTgwNjExWjAQMQ4wDAYDVQQDDAV1c2VyMDB2MBAGByqGSM49AgEGBSuBBAAiA2IABBiWSo/j8EFit7aUMm5lF+lUmCu+IgfnpFD+7QMgLKtxRJ3aGSqgS/GpqcYVGddnODtSarNE/HyGKUFUolLPQ5ybHcouUk0kyfA7XMeSoUA4lBz63Wha8wmXo+NdBRo39qNTMFEwHQYDVR0OBBYEFPtuhrwgGjDFHeUUT4nGsXaZn69KMB8GA1UdIwQYMBaAFPtuhrwgGjDFHeUUT4nGsXaZn69KMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwMDaAAwZQIxAOnozm2CyqRwSSQLls5r+mUHRGRyXHXwYtM4Dcst/VEZdmS9fqvHRCHbjUlO/+HNfgIwMWZ4FmsjD3wnPxONOm9YdVn/PRD7SsPRPbOjwBiE4EBGaHDsLjYAGDSGi7NJnSkA-----END CERTIFICATE-----", "ledgerRoleName": "Reader" } ] diff --git a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json index d822f7d26004..f2bcfa57d958 100644 --- a/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json +++ b/specification/confidentialledger/resource-manager/Microsoft.ConfidentialLedger/preview/2021-05-13-preview/examples/ConfidentialLedger_Update.json @@ -5,7 +5,22 @@ "resourceGroupName": "DummyResourceGroupName", "ledgerName": "DummyLedgerName", "confidentialLedger": { - "properties": {}, + "properties": { + "ledgerType": "Public", + "aadBasedSecurityPrincipals": [ + { + "principalId": "34621747-6fc8-4771-a2eb-72f31c461f2e", + "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", + "ledgerRoleName": "Administrator" + } + ], + "certBasedSecurityPrincipals": [ + { + "cert": "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIQJ2IrDBawSkiAbkBYmiAopDANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwHhcNMjAwOTIzMjIxODQ2WhcNMjEwOTIzMjIyODQ2WjAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX2s/Eu4q/eQ63N+Ugeg5oAciZua/YCJr41c/696szvSY7Zg1SNJlW88/nbz70+QpO55OmqlEE3QCU+T0Vl/h0Gf//n1PYcoBbTGUnYEmV+fTTHict6rFiEwrGJ62tvcpYgwapInSLyEeUzjki0zhOLJ1OfRnYd1eGnFVMpE5aVjiS8Q5dmTEUyd51EIprGE8RYAW9aeWSwTH7gjHUsRlJnHKcdhaK/v5QKJnNu5bzPFUcpC0ZBcizoMPAtroLAD4B68Jl0z3op18MgZe6lRrVoWuxfqnk5GojuB/Vu8ohAZKoFhQ6NB6r+LL2AUs+Zr7Bt26IkEdR178n9JMEA4gHAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBS/a7PU9iOfOKEyZCp11Oen5VSuuDAdBgNVHQ4EFgQUv2uz1PYjnzihMmQqddTnp+VUrrgwDQYJKoZIhvcNAQELBQADggEBAF5q2fDwnse8egXhfaJCqqM969E9gSacqFmASpoDJPRPEX7gqoO7v1ww7nqRtRDoRiBvo/yNk7jlSAkRN3nRRnZLZZ3MYQdmCr4FGyIqRg4Y94+nja+Du9pDD761rxRktMVPSOaAVM/E5DQvscDlPvlPYe9mkcrLCE4DXYpiMmLT8Tm55LJJq5m07dVDgzAIR1L/hmEcbK0pnLgzciMtMLxGO2udnyyW/UW9WxnjvrrD2JluTHH9mVbb+XQP1oFtlRBfH7aui1ZgWfKvxrdP4zdK9QoWSUvRux3TLsGmHRBjBMtqYDY3y5mB+aNjLelvWpeVb0m2aOSVXynrLwNCAVA=\n-----END CERTIFICATE-----", + "ledgerRoleName": "Reader" + } + ] + }, "location": "EastUS", "tags": { "additionalProps1": "additional properties", @@ -18,8 +33,8 @@ "body": { "properties": { "ledgerName": "DummyLedgerName", - "ledgerUri": "https://dummy.accledger.domain.com/DummyLedgerName", - "identityServiceUri": "https://dummy.accledger.identity.com/DummyLedgerName", + "ledgerUri": "https://dummyledgername.confidential-ledger.azure.com", + "identityServiceUri": "https://identity.confidential-ledger.core.azure.com/ledgerIdentity/dummyledgername", "ledgerType": "Public", "ledgerInternalNamespace": "dummyNamespace", "provisioningState": "Succeeded", @@ -29,6 +44,12 @@ "tenantId": "bce123b9-2b7b-4975-8360-5ca0b9b1cd08", "ledgerRoleName": "Administrator" } + ], + "certBasedSecurityPrincipals": [ + { + "cert": "-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIQJ2IrDBawSkiAbkBYmiAopDANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwHhcNMjAwOTIzMjIxODQ2WhcNMjEwOTIzMjIyODQ2WjAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX2s/Eu4q/eQ63N+Ugeg5oAciZua/YCJr41c/696szvSY7Zg1SNJlW88/nbz70+QpO55OmqlEE3QCU+T0Vl/h0Gf//n1PYcoBbTGUnYEmV+fTTHict6rFiEwrGJ62tvcpYgwapInSLyEeUzjki0zhOLJ1OfRnYd1eGnFVMpE5aVjiS8Q5dmTEUyd51EIprGE8RYAW9aeWSwTH7gjHUsRlJnHKcdhaK/v5QKJnNu5bzPFUcpC0ZBcizoMPAtroLAD4B68Jl0z3op18MgZe6lRrVoWuxfqnk5GojuB/Vu8ohAZKoFhQ6NB6r+LL2AUs+Zr7Bt26IkEdR178n9JMEA4gHAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBS/a7PU9iOfOKEyZCp11Oen5VSuuDAdBgNVHQ4EFgQUv2uz1PYjnzihMmQqddTnp+VUrrgwDQYJKoZIhvcNAQELBQADggEBAF5q2fDwnse8egXhfaJCqqM969E9gSacqFmASpoDJPRPEX7gqoO7v1ww7nqRtRDoRiBvo/yNk7jlSAkRN3nRRnZLZZ3MYQdmCr4FGyIqRg4Y94+nja+Du9pDD761rxRktMVPSOaAVM/E5DQvscDlPvlPYe9mkcrLCE4DXYpiMmLT8Tm55LJJq5m07dVDgzAIR1L/hmEcbK0pnLgzciMtMLxGO2udnyyW/UW9WxnjvrrD2JluTHH9mVbb+XQP1oFtlRBfH7aui1ZgWfKvxrdP4zdK9QoWSUvRux3TLsGmHRBjBMtqYDY3y5mB+aNjLelvWpeVb0m2aOSVXynrLwNCAVA=\n-----END CERTIFICATE-----", + "ledgerRoleName": "Reader" + } ] }, "name": "DummyLedgerName", diff --git a/specification/confidentialledger/resource-manager/readme.az.md b/specification/confidentialledger/resource-manager/readme.az.md new file mode 100644 index 000000000000..f709177a215f --- /dev/null +++ b/specification/confidentialledger/resource-manager/readme.az.md @@ -0,0 +1,12 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: confidentialledger + namespace: azure.mgmt.confidentialledger + package-name: azure-mgmt-confidentialledger +az-output-folder: $(azure-cli-extension-folder)/src/confidentialledger +python-sdk-output-folder: "$(az-output-folder)/azext_confidentialledger/vendored_sdks/confidentialledger" +``` \ No newline at end of file diff --git a/specification/confidentialledger/resource-manager/readme.cli.md b/specification/confidentialledger/resource-manager/readme.cli.md new file mode 100644 index 000000000000..179636a56760 --- /dev/null +++ b/specification/confidentialledger/resource-manager/readme.cli.md @@ -0,0 +1,4 @@ +``` yaml +# add any configuration here for all CLI languages +# refer to the faq.md for more details +``` \ No newline at end of file diff --git a/specification/confidentialledger/resource-manager/readme.md b/specification/confidentialledger/resource-manager/readme.md index 640a3b03ad91..a978b33a9719 100644 --- a/specification/confidentialledger/resource-manager/readme.md +++ b/specification/confidentialledger/resource-manager/readme.md @@ -60,7 +60,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-go-track2 @@ -68,6 +68,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_confidentialledger'] + - repo: azure-cli-extensions ``` ## Go diff --git a/specification/confidentialledger/resource-manager/readme.python.md b/specification/confidentialledger/resource-manager/readme.python.md index d51e32acadda..aef6ed5ec919 100644 --- a/specification/confidentialledger/resource-manager/readme.python.md +++ b/specification/confidentialledger/resource-manager/readme.python.md @@ -3,19 +3,21 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: microsoft.confidentialledger - package-name: azure-mgmt-confidentialledger - package-version: 0.0.1 - clear-output-folder: true +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-confidentialledger +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true ``` -```yaml $(python) -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger/azure/mgmt/confidentialledger +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/confidentialledger/azure-mgmt-confidentialledger ``` diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json index b5d2085203ef..94c68febd05d 100644 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2021-09-01-preview/confluent.json @@ -660,7 +660,10 @@ "type": "array", "items": { "$ref": "#/definitions/OperationResult" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "URL to get the next set of operation list results if there are any.", @@ -694,7 +697,11 @@ "readOnly": true, "items": { "$ref": "#/definitions/ErrorResponseBody" - } + }, + "x-ms-identifiers": [ + "message", + "target" + ] } } }, diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/stable/2020-03-01/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/stable/2020-03-01/confluent.json index a5d955874d8a..e64e668d2c59 100644 --- a/specification/confluent/resource-manager/Microsoft.Confluent/stable/2020-03-01/confluent.json +++ b/specification/confluent/resource-manager/Microsoft.Confluent/stable/2020-03-01/confluent.json @@ -598,7 +598,10 @@ "type": "array", "items": { "$ref": "#/definitions/OperationResult" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "URL to get the next set of operation list results if there are any.", @@ -633,7 +636,11 @@ "readOnly": true, "items": { "$ref": "#/definitions/ErrorResponseBody" - } + }, + "x-ms-identifiers": [ + "message", + "target" + ] } } }, diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsCreate.json new file mode 100644 index 000000000000..09fc41c570fd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2022-02-02-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsDelete.json new file mode 100644 index 000000000000..3c561393ac47 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2022-02-02-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsGet.json new file mode 100644 index 000000000000..1c22b08c1371 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2022-02-02-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsList.json new file mode 100644 index 000000000000..6e66cf956cd3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2022-02-02-preview", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..dc16c2323f5d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2022-02-02-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json index dc89ef57ae6f..6ac13432b262 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-02-02-preview/managedClusters.json @@ -2234,6 +2234,224 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_List", + "summary": "Gets a list of managed cluster snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/ManagedClusterSnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_ListByResourceGroup", + "summary": "Lists managed cluster snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Get", + "summary": "Gets a managed cluster snapshot.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_CreateOrUpdate", + "summary": "Creates or updates a managed cluster snapshot.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The managed cluster snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsCreate.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Delete", + "summary": "Deletes a managed cluster snapshot.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsDelete.json" + } + } + } } }, "definitions": { @@ -5556,6 +5774,24 @@ }, "description": "The response from the List Snapshots operation." }, + "ManagedClusterSnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The list of managed cluster snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Cluster Snapshots operation." + }, "Snapshot": { "type": "object", "properties": { @@ -5577,6 +5813,27 @@ ], "description": "A node pool snapshot resource." }, + "ManagedClusterSnapshot": { + "type": "object", + "properties": { + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "The system metadata relating to this snapshot." + }, + "properties": { + "description": "Properties of a managed cluster snapshot.", + "$ref": "#/definitions/ManagedClusterSnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "A managed cluster snapshot resource." + }, "SnapshotProperties": { "type": "object", "properties": { @@ -5618,11 +5875,155 @@ }, "description": "Properties used to configure a node pool snapshot." }, + "ManagedClusterSnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "managedClusterPropertiesReadOnly": { + "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot", + "description": "What the properties are snapshoted when getting managed cluster snapshot. Those properties are read-only." + } + }, + "description": "Properties for a managed cluster snapshot." + }, + "ManagedClusterPropertiesForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The current kubernetes version." + }, + "sku": { + "type": "object", + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The current managed cluster sku." + }, + "enableRbac": { + "type": "boolean", + "description": "Whether the cluster that snapshoted has enabled Kubernetes Role-Based Access Control or not." + }, + "networkProfile": { + "type": "object", + "$ref": "#/definitions/NetworkProfileForSnapshot", + "description": "The current network profile that snapshoted." + } + } + }, + "NetworkProfileForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "title": "The network mode Azure CNI is configured with.", + "description": "This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "title": "The load balancer sku for the managed cluster.", + "description": "The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + } + } + }, "SnapshotType": { "type": "string", "default": "NodePool", "enum": [ - "NodePool" + "NodePool", + "ManagedCluster" ], "x-ms-enum": { "name": "SnapshotType", diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-04-01/examples/MSIManagedClusterCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-04-01/examples/MSIManagedClusterCreate_Update.json new file mode 100644 index 000000000000..bfe38503e3f5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-04-01/examples/MSIManagedClusterCreate_Update.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2019-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile":{ + "loadBalancerSku": "basic" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "addonProfiles": { + }, + "enableRBAC": true, + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "msi" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00630bf6-aaaa-bbbb-cccc-22cf1e3bd337", + "tenantId": "89e1b688-aaaa-bbbb-cccc-54d0a43a4f0d" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "msi" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "enablePodSecurityPolicy": true, + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "00630bf6-aaaa-bbbb-cccc-22cf1e3bd337", + "tenantId": "89e1b688-aaaa-bbbb-cccc-54d0a43a4f0d" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json index ad2b07826fc4..8f938c7d3d3e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json @@ -1365,6 +1365,9 @@ "type": "object", "$ref": "#/definitions/ReportConfigAggregation" }, + "x-ms-identifiers": [ + "name" + ], "maxItems": 2 }, "grouping": { @@ -1373,6 +1376,10 @@ "items": { "$ref": "#/definitions/ReportConfigGrouping" }, + "x-ms-identifiers": [ + "name", + "type" + ], "maxItems": 2 }, "sorting": { @@ -1380,7 +1387,8 @@ "type": "array", "items": { "$ref": "#/definitions/ReportConfigSorting" - } + }, + "x-ms-identifiers": [] }, "filter": { "type": "object", @@ -1476,6 +1484,7 @@ "items": { "$ref": "#/definitions/ReportConfigFilter" }, + "x-ms-identifiers": [], "minItems": 2 }, "or": { @@ -1484,6 +1493,7 @@ "items": { "$ref": "#/definitions/ReportConfigFilter" }, + "x-ms-identifiers": [], "minItems": 2 }, "dimensions": { @@ -1670,7 +1680,10 @@ "type": "array", "items": { "$ref": "#/definitions/PivotProperties" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -2055,17 +2068,20 @@ "resourceGroupFilter": { "description": "array of resourceGroups to filter by", "type": "array", - "items": {} + "items": {}, + "x-ms-identifiers": [] }, "resourceFilter": { "description": "array of resources to filter by", "type": "array", - "items": {} + "items": {}, + "x-ms-identifiers": [] }, "meterFilter": { "description": "array of meters to filter by", "type": "array", - "items": {} + "items": {}, + "x-ms-identifiers": [] }, "tagFilter": { "description": "tags to filter by", @@ -2240,15 +2256,20 @@ "type": "array", "items": { "$ref": "#/definitions/QueryColumn" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "rows": { "description": "Array of rows", "type": "array", "items": { "type": "array", - "items": {} - } + "items": {}, + "x-ms-identifiers": [] + }, + "x-ms-identifiers": [] } } }, @@ -2520,6 +2541,10 @@ "items": { "$ref": "#/definitions/QueryGrouping" }, + "x-ms-identifiers": [ + "name", + "type" + ], "maxItems": 2 }, "filter": { @@ -2635,6 +2660,7 @@ "items": { "$ref": "#/definitions/QueryFilter" }, + "x-ms-identifiers": [], "minItems": 2 }, "or": { @@ -2643,6 +2669,7 @@ "items": { "$ref": "#/definitions/QueryFilter" }, + "x-ms-identifiers": [], "minItems": 2 }, "dimensions": { diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Create.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Create.json new file mode 100644 index 000000000000..d32b526031bf --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "requestBody": { + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "zoneRedundancy": "Enabled" + }, + "identity": { + "type": "systemAssigned" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Accepted", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Delete.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Delete.json new file mode 100644 index 000000000000..82362f6340c1 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Get.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Get.json new file mode 100644 index 000000000000..d02546640831 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + } + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_List.json new file mode 100644 index 000000000000..de3a486126f3 --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_ListByResourceGroup.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_ListByResourceGroup.json new file mode 100644 index 000000000000..a6b44de2051e --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_ListByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Update.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Update.json new file mode 100644 index 000000000000..9da2de0de77d --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Update.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "myWorkspace", + "requestBody": { + "tags": { + "Environment": "Dev 2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/grafana/myWorkspace", + "name": "myWorkspace", + "type": "Microsoft.Dashboard/grafana", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "grafanaVersion": "7.1", + "endpoint": "my.azgrafana.io", + "zoneRedundancy": "Enabled" + }, + "tags": { + "Environment": "Dev 2" + }, + "location": "West US" + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Operations_List.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..cf2cb2e7a4ad --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2021-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Dashboard/grafana/write", + "display": { + "provider": "Microsoft.Dashboard", + "resource": "grafana", + "operation": "write", + "description": "Write grafana workspace resource" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/grafana.json b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/grafana.json new file mode 100644 index 000000000000..85d244fc6f7e --- /dev/null +++ b/specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/grafana.json @@ -0,0 +1,753 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Dashboard", + "description": "The Microsoft.Dashboard Rest API spec.", + "version": "2021-09-01-preview" + }, + "paths": { + "/providers/Microsoft.Dashboard/operations": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all available API operations provided by Microsoft.Dashboard.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all available API operations provided by Microsoft.Dashboard.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Dashboard/grafana": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all resources of workspaces for Grafana under the specified subscription.", + "operationId": "Grafana_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all resources of workspaces for Grafana under the specified subscription.", + "schema": { + "$ref": "#/definitions/GrafanaResourceListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Grafana_List": { + "$ref": "./examples/Grafana_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "List all resources of workspaces for Grafana under the specified resource group.", + "operationId": "Grafana_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return all resources of workspaces for Grafana under the given resource group.", + "schema": { + "$ref": "#/definitions/GrafanaResourceListResponse" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Grafana_ListByResourceGroup": { + "$ref": "./examples/Grafana_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}": { + "get": { + "tags": [ + "GrafanaResource" + ], + "summary": "Get the properties of a specific workspace for Grafana resource.", + "operationId": "Grafana_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Return the properties of the required workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/GrafanaResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Grafana_Get": { + "$ref": "./examples/Grafana_Get.json" + } + } + }, + "put": { + "tags": [ + "GrafanaResource" + ], + "summary": "Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.", + "operationId": "Grafana_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GrafanaResource" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully create a workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/GrafanaResource" + } + }, + "201": { + "description": "Created. The operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/GrafanaResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Grafana_Create": { + "$ref": "./examples/Grafana_Create.json" + } + } + }, + "patch": { + "tags": [ + "GrafanaResource" + ], + "summary": "Update a workspace for Grafana resource.", + "operationId": "Grafana_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GrafanaResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. Successfully update the workspace for Grafana resource.", + "schema": { + "$ref": "#/definitions/GrafanaResource" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Grafana_Update": { + "$ref": "./examples/Grafana_Update.json" + } + } + }, + "delete": { + "tags": [ + "GrafanaResource" + ], + "summary": "Delete a workspace for Grafana resource.", + "operationId": "Grafana_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The workspace for Grafana resource is deleted." + }, + "202": { + "description": "Accepted. The operation is accepted and will be completed asynchronously." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Grafana_Delete": { + "$ref": "./examples/Grafana_Delete.json" + } + } + } + } + }, + "definitions": { + "ActionType": { + "description": "Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.", + "enum": [ + "Internal" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "ActionType" + } + }, + "CreatedByType": { + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CreatedByType" + } + }, + "GrafanaResource": { + "type": "object", + "description": "The grafana resource type.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the grafana resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the grafana resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the grafana resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The Sku of the grafana resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties specific to the grafana resource.", + "$ref": "#/definitions/GrafanaResourceProperties" + }, + "identity": { + "description": "The managed identity of the grafana resource.", + "$ref": "#/definitions/ManagedIdentity" + }, + "systemData": { + "description": "The system meta data relating to this grafana resource.", + "$ref": "#/definitions/SystemData" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The tags for grafana resource." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the grafana resource lives" + } + } + }, + "GrafanaResourceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GrafanaResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "GrafanaResourceProperties": { + "type": "object", + "description": "Properties specific to the grafana resource.", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "grafanaVersion": { + "description": "The Grafana software version.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The endpoint of the Grafana instance.", + "type": "string", + "readOnly": true + }, + "zoneRedundancy": { + "$ref": "#/definitions/ZoneRedundancy" + } + } + }, + "GrafanaResourceUpdateParameters": { + "type": "object", + "description": "The parameters for a PATCH request to a grafana resource.", + "properties": { + "identity": { + "description": "The managed identity of the grafana resource.", + "$ref": "#/definitions/ManagedIdentity" + }, + "tags": { + "type": "object", + "description": "The new tags of the grafana resource.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "LastModifiedByType": { + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LastModifiedByType" + } + }, + "ManagedIdentity": { + "description": "The managed identity of a resource.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityTypes" + }, + "principalId": { + "description": "The principal id of the system assigned identity.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the system assigned identity.", + "type": "string", + "readOnly": true + }, + "userAssignedIdentities": { + "description": "Dictionary of user assigned identities.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "ManagedIdentityTypes": { + "description": "The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the resource.", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "OperationDisplay": { + "description": "Localized display information for this particular operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name, i.e., Microsoft.Dashboard.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly name of the resource type related to this operation, e.g., 'grafana'.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Description of the operation, e.g., 'Read grafana'.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "A list of REST API operations supported by Microsoft.Dashboard provider. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Dashboard provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "OperationResult": { + "description": "A Microsoft.Dashboard REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "isDataAction": { + "description": "Indicates whether the operation applies to data-plane. Set \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.", + "type": "boolean", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "$ref": "#/definitions/Origin" + }, + "actionType": { + "$ref": "#/definitions/ActionType" + } + } + }, + "Origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system", + "user,system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "Origin" + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "SystemData": { + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string" + }, + "createdByType": { + "$ref": "#/definitions/CreatedByType" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "lastModifiedBy": { + "type": "string" + }, + "lastModifiedByType": { + "$ref": "#/definitions/LastModifiedByType" + }, + "lastModifiedAt": { + "format": "date-time", + "type": "string" + } + } + }, + "ZoneRedundancy": { + "enum": [ + "Disabled", + "Enabled" + ], + "default": "Disabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ZoneRedundancy" + } + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "description": "The principal id of user assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client id of user assigned identity.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "parameters": { + "WorkspaceNameParameter": { + "in": "path", + "name": "workspaceName", + "description": "The name of Azure Managed Workspace for Grafana.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "default": "2021-09-01-preview", + "description": "The API version to be used with the HTTP request (e.g. YYYY-MM-DD).", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "minLength": 1, + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive." + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + } + } +} diff --git a/specification/dashboard/resource-manager/readme.csharp.md b/specification/dashboard/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..79d82b928253 --- /dev/null +++ b/specification/dashboard/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.Dashboard + output-folder: $(csharp-sdks-folder)/dashboard/Microsoft.Azure.Management.Dashboard/src/Generated +``` diff --git a/specification/dashboard/resource-manager/readme.go.md b/specification/dashboard/resource-manager/readme.go.md new file mode 100644 index 000000000000..6f4c7811b182 --- /dev/null +++ b/specification/dashboard/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/dashboard/armdashboard +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` diff --git a/specification/dashboard/resource-manager/readme.java.md b/specification/dashboard/resource-manager/readme.java.md new file mode 100644 index 000000000000..8f81a1c9b7cc --- /dev/null +++ b/specification/dashboard/resource-manager/readme.java.md @@ -0,0 +1,33 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.dashboard +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dashboard +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2021-09-01-preview +``` + +### Tag: package-2021-09-01-preview and java + +These settings apply only when `--tag=package-2021-09-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2021-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.dashboard.v2021_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/dashboard/mgmt-v2021_09_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/dashboard/resource-manager/readme.md b/specification/dashboard/resource-manager/readme.md new file mode 100644 index 000000000000..89d375ae98eb --- /dev/null +++ b/specification/dashboard/resource-manager/readme.md @@ -0,0 +1,53 @@ +# Dashboard + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Dashboard. + +--- +## Getting Started +To build the SDK for Dashboard, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- +## Configuration +### Basic Information +These are the global settings for the Dashboard API. + +```yaml +title: DashboardManagementClient +openapi-type: arm +openapi-subtype: rpaas +tag: package-2021-09-01-preview +``` + +### Tag: package-2021-09-01-preview + +These settings apply only when `--tag=package-2021-09-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2021-09-01-preview' +input-file: + - Microsoft.Dashboard/preview/2021-09-01-preview/grafana.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-go-track2 + - repo: azure-resource-manager-schemas + - repo: azure-sdk-for-js + - repo: azure-sdk-for-java +``` diff --git a/specification/dashboard/resource-manager/readme.python.md b/specification/dashboard/resource-manager/readme.python.md new file mode 100644 index 000000000000..318a46d8c555 --- /dev/null +++ b/specification/dashboard/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-dashboard +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/dashboard/azure-mgmt-dashboard/azure/mgmt/dashboard +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/dashboard/azure-mgmt-dashboard +``` diff --git a/specification/dashboard/resource-manager/readme.typescript.md b/specification/dashboard/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..f4c6f6b22555 --- /dev/null +++ b/specification/dashboard/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-dashboard" + output-folder: "$(typescript-sdks-folder)/sdk/dashboard/arm-dashboard" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json index 4d18086b9234..3d9465803f2b 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2021-05-01/databox.json @@ -1021,6 +1021,9 @@ "items": { "$ref": "#/definitions/ShareCredentialDetails" }, + "x-ms-identifiers": [ + "shareName" + ], "readOnly": true } } @@ -1097,6 +1100,7 @@ "items": { "$ref": "#/definitions/ShippingAddress" }, + "x-ms-identifiers": [], "readOnly": true } }, @@ -1231,6 +1235,9 @@ "items": { "$ref": "#/definitions/SkuInformation" }, + "x-ms-identifiers": [ + "sku" + ], "readOnly": true }, "nextLink": { @@ -1328,6 +1335,10 @@ "items": { "$ref": "#/definitions/CloudError" }, + "x-ms-identifiers": [ + "message", + "target" + ], "readOnly": true }, "additionalInfo": { @@ -1336,6 +1347,7 @@ "items": { "$ref": "#/definitions/AdditionalErrorInfo" }, + "x-ms-identifiers": [], "readOnly": true } }, @@ -1378,7 +1390,8 @@ "type": "array", "items": { "$ref": "#/definitions/NotificationPreference" - } + }, + "x-ms-identifiers": [] } } }, @@ -1866,6 +1879,9 @@ "items": { "$ref": "#/definitions/DataBoxDiskCopyProgress" }, + "x-ms-identifiers": [ + "serialNumber" + ], "readOnly": true }, "disksAndSizeDetails": { @@ -1899,6 +1915,9 @@ "items": { "$ref": "#/definitions/DiskSecret" }, + "x-ms-identifiers": [ + "diskSerialNumber" + ], "readOnly": true }, "passKey": { @@ -1969,6 +1988,10 @@ "items": { "$ref": "#/definitions/CopyProgress" }, + "x-ms-identifiers": [ + "dataAccountType", + "accountId" + ], "readOnly": true }, "devicePassword": { @@ -1993,6 +2016,9 @@ "items": { "$ref": "#/definitions/DataBoxHeavySecret" }, + "x-ms-identifiers": [ + "deviceSerialNumber" + ], "readOnly": true } }, @@ -2018,6 +2044,9 @@ "items": { "$ref": "#/definitions/ApplianceNetworkConfiguration" }, + "x-ms-identifiers": [ + "name" + ], "readOnly": true }, "encodedValidationCertPubKey": { @@ -2031,6 +2060,9 @@ "items": { "$ref": "#/definitions/AccountCredentialDetails" }, + "x-ms-identifiers": [ + "accountName" + ], "readOnly": true } } @@ -2054,6 +2086,10 @@ "items": { "$ref": "#/definitions/CopyProgress" }, + "x-ms-identifiers": [ + "dataAccountType", + "accountId" + ], "readOnly": true }, "devicePassword": { @@ -2077,7 +2113,10 @@ "type": "array", "items": { "$ref": "#/definitions/DataBoxSecret" - } + }, + "x-ms-identifiers": [ + "deviceSerialNumber" + ] } }, "x-ms-discriminator-value": "DataBox" @@ -2117,6 +2156,9 @@ "items": { "$ref": "#/definitions/ApplianceNetworkConfiguration" }, + "x-ms-identifiers": [ + "name" + ], "readOnly": true }, "encodedValidationCertPubKey": { @@ -2130,6 +2172,9 @@ "items": { "$ref": "#/definitions/AccountCredentialDetails" }, + "x-ms-identifiers": [ + "accountName" + ], "readOnly": true } } @@ -2223,14 +2268,16 @@ "type": "array", "items": { "$ref": "#/definitions/DataExportDetails" - } + }, + "x-ms-identifiers": [] }, "dataImportDetails": { "description": "List of DataTransfer details to be used to import data to azure.", "type": "array", "items": { "$ref": "#/definitions/DataImportDetails" - } + }, + "x-ms-identifiers": [] }, "deviceType": { "description": "Device type.", @@ -2440,7 +2487,8 @@ "type": "array", "items": { "$ref": "#/definitions/Details" - } + }, + "x-ms-identifiers": [] }, "target": { "type": "string" @@ -2537,6 +2585,9 @@ "items": { "$ref": "#/definitions/JobStages" }, + "x-ms-identifiers": [ + "stageName" + ], "readOnly": true }, "contactDetails": { @@ -2562,14 +2613,16 @@ "type": "array", "items": { "$ref": "#/definitions/DataImportDetails" - } + }, + "x-ms-identifiers": [] }, "dataExportDetails": { "description": "Details of the data to be exported from azure.", "type": "array", "items": { "$ref": "#/definitions/DataExportDetails" - } + }, + "x-ms-identifiers": [] }, "jobDetailsType": { "description": "Indicates the type of job details.", @@ -2608,6 +2661,7 @@ "items": { "$ref": "#/definitions/CopyLogDetails" }, + "x-ms-identifiers": [], "readOnly": true }, "reverseShipmentLabelSasKey": { @@ -3445,6 +3499,9 @@ "items": { "$ref": "#/definitions/Operation" }, + "x-ms-identifiers": [ + "name" + ], "readOnly": true }, "nextLink": { @@ -4182,6 +4239,9 @@ "items": { "$ref": "#/definitions/DataLocationToServiceLocationMap" }, + "x-ms-identifiers": [ + "dataLocation" + ], "readOnly": true }, "capacity": { @@ -4195,6 +4255,9 @@ "items": { "$ref": "#/definitions/SkuCost" }, + "x-ms-identifiers": [ + "meterId" + ], "readOnly": true }, "apiVersions": { @@ -4509,7 +4572,10 @@ "type": "array", "items": { "$ref": "#/definitions/FilterFileDetails" - } + }, + "x-ms-identifiers": [ + "filterFilePath" + ] } } }, @@ -4585,6 +4651,7 @@ "items": { "$ref": "#/definitions/TransportAvailabilityDetails" }, + "x-ms-identifiers": [], "readOnly": true } } @@ -4645,7 +4712,10 @@ "type": "array", "items": { "$ref": "#/definitions/UnencryptedCredentials" - } + }, + "x-ms-identifiers": [ + "jobName" + ] }, "nextLink": { "description": "Link for the next set of unencrypted credentials.", @@ -4898,7 +4968,8 @@ "type": "array", "items": { "$ref": "#/definitions/ValidationInputRequest" - } + }, + "x-ms-identifiers": [] } }, "discriminator": "validationCategory" @@ -4953,6 +5024,7 @@ "items": { "$ref": "#/definitions/ValidationInputResponse" }, + "x-ms-identifiers": [], "readOnly": true } } diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json index c0472ec55aad..3b68be5ac479 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json @@ -409,7 +409,11 @@ "type": "array", "items": { "$ref": "#/definitions/WorkspaceProviderAuthorization" - } + }, + "x-ms-identifiers": [ + "roleDefinitionId", + "principalId" + ] }, "createdBy": { "description": "Indicates the Object ID, PUID and Application ID of entity that created the workspace.", @@ -833,7 +837,11 @@ "type": "array", "items": { "$ref": "#/definitions/ErrorDetail" - } + }, + "x-ms-identifiers": [ + "message", + "target" + ] }, "innererror": { "description": "Inner error details if they exist.", @@ -910,6 +918,9 @@ "items": { "$ref": "#/definitions/Operation" }, + "x-ms-identifiers": [ + "name" + ], "description": "List of Resource Provider operations supported by the Resource Provider resource provider." }, "nextLink": { diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json index c88a288c5d03..bf22765de979 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/vnetpeering.json @@ -274,7 +274,11 @@ "type": "array", "items": { "$ref": "#/definitions/ErrorDetail" - } + }, + "x-ms-identifiers": [ + "message", + "target" + ] }, "innererror": { "description": "Inner error details if they exist.", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/dataprotection.json new file mode 100644 index 000000000000..9973ece256dd --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/dataprotection.json @@ -0,0 +1,6410 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-01-01", + "title": "DataProtectionBackupClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a subscription.", + "operationId": "BackupVaults_GetInSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in Subscription": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "GetOperationResult" + ], + "description": "Gets the operation result for a resource", + "operationId": "OperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets the operation status for a resource.", + "x-ms-examples": { + "Get OperationResult": { + "$ref": "./examples/GetOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for a resource.", + "operationId": "OperationStatus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for an operation over a BackupVault's context.", + "operationId": "OperationStatusBackupVaultContext_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatusVaultContext.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for an operation over a ResourceGroup's context.", + "operationId": "OperationStatusResourceGroupContext_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatusRGContext.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a resource group.", + "operationId": "BackupVaults_GetInResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in ResourceGroup": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns a resource belonging to a resource group.", + "operationId": "BackupVaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupVault": { + "$ref": "./examples/VaultCRUD/GetBackupVault.json" + }, + "Get BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json" + } + } + }, + "put": { + "tags": [ + "BackupVaults" + ], + "description": "Creates or updates a BackupVault resource belonging to a resource group.", + "operationId": "BackupVaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupVault": { + "$ref": "./examples/VaultCRUD/PutBackupVault.json" + }, + "Create BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupVaults" + ], + "description": "Deletes a BackupVault resource from the resource group.", + "operationId": "BackupVaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupVault": { + "$ref": "./examples/VaultCRUD/DeleteBackupVault.json" + } + } + }, + "patch": { + "tags": [ + "BackupVaults" + ], + "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", + "operationId": "BackupVaults_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceRequestInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch BackupVault": { + "$ref": "./examples/VaultCRUD/PatchBackupVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "BackupVaultOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetOperationResult Patch": { + "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "BackupVaults" + ], + "summary": "API to check for resource name availability", + "operationId": "BackupVaults_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "description": "The location in which uniqueness will be verified.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Check name availability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check BackupVaults name availability": { + "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": { + "post": { + "tags": [ + "DppFeatureSupport" + ], + "summary": "Validates if a feature is supported", + "operationId": "DataProtection_CheckFeatureSupport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Feature support request object", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Azure Vm Backup Feature Support": { + "$ref": "./examples/CheckfeatureSupport.json" + } + } + } + }, + "/providers/Microsoft.DataProtection/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "DataProtectionOperations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": { + "get": { + "tags": [ + "BackupPolicies" + ], + "description": "Returns list of backup policies belonging to a backup vault", + "operationId": "BackupPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupPolicy": { + "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Get", + "description": "Gets a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets a backup policy belonging to a backup vault", + "x-ms-examples": { + "Get BackupPolicy": { + "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json" + } + } + }, + "put": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_CreateOrUpdate", + "summary": "Creates or Updates a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "description": "Name of the policy", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate BackupPolicy": { + "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json" + } + } + }, + "delete": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Delete", + "summary": "Deletes a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupPolicy": { + "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instances belonging to a backup vault", + "operationId": "BackupInstances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupInstances in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instance with name in a backup vault", + "operationId": "BackupInstances_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json" + } + } + }, + "put": { + "tags": [ + "BackupInstances" + ], + "description": "Create or update a backup instance in a backup vault", + "operationId": "BackupInstances_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupInstances" + ], + "description": "Delete a backup instance in a backup vault", + "operationId": "BackupInstances_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "Ok" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Trigger adhoc backup ", + "operationId": "BackupInstances_AdhocBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Trigger Adhoc Backup": { + "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validate whether adhoc backup will be successful or not", + "operationId": "BackupInstances_ValidateForBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateForBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate For Backup": { + "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Get result of backup instance creation operation", + "operationId": "BackupInstances_GetBackupInstanceOperationResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupInstanceOperationResult": { + "$ref": "./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Returns a list of Recovery Points for a DataSource in a vault.", + "operationId": "RecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RecoveryPointsFilters", + "x-ms-examples": { + "List Recovery Points in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Recovery Point": { + "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": { + "post": { + "description": "rehydrate recovery point for restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRehydrate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "description": "Request body for operation", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRehydrationRequest" + } + }, + { + "in": "path", + "name": "backupInstanceName", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "tags": [ + "BackupInstances" + ], + "x-ms-examples": { + "Trigger Rehydrate": { + "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Triggers restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Restore": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json" + }, + "Trigger Restore As Files": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json" + }, + "Trigger Restore With Rehydration": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume backups for backup instance", + "operationId": "BackupInstances_ResumeBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeBackups": { + "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume protection for a stopped backup instance", + "operationId": "BackupInstances_ResumeProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeProtection": { + "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop protection of a backup instance and data will be held forever", + "operationId": "BackupInstances_StopProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StopProtection": { + "$ref": "./examples/BackupInstanceOperations/StopProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop backups for backup instance", + "operationId": "BackupInstances_SuspendBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SuspendBackups": { + "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state", + "operationId": "BackupInstances_SyncBackupInstance", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/SyncBackupInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Sync BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validates if Restore can be triggered for a DataSource", + "operationId": "BackupInstances_ValidateForRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate Restore": { + "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": { + "get": { + "tags": [ + "AzureBackupJobs" + ], + "description": "Returns list of jobs belonging to a backup vault", + "operationId": "Jobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupJobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Jobs": { + "$ref": "./examples/JobCRUD/ListJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { + "post": { + "tags": [ + "FindRestorableTimeRanges" + ], + "operationId": "RestorableTimeRanges_Find", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the backup instance", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Find Restorable Time Ranges": { + "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets a job with id in a backup vault", + "operationId": "Jobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "jobId", + "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupJobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Job": { + "$ref": "./examples/JobCRUD/GetJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": { + "post": { + "tags": [ + "AzureBackupJob" + ], + "description": "Triggers export of jobs and returns an OperationID to track.", + "operationId": "ExportJobs_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Trigger Export Jobs": { + "$ref": "./examples/JobCRUD/TriggerExportJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "operationId": "ExportJobsOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "description": "OperationID which represents the export job.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExportJobsResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Export Jobs Operation Result": { + "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns ResourceGuards collection belonging to a subscription.", + "operationId": "ResourceGuards_GetResourcesInSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get ResourceGuards in Subscription": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns ResourceGuards collection belonging to a ResourceGroup.", + "operationId": "ResourceGuards_GetResourcesInResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get ResourceGuards in ResourceGroup": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}": { + "put": { + "tags": [ + "ResourceGuards" + ], + "summary": "Creates or updates a ResourceGuard resource belonging to a resource group.", + "operationId": "ResourceGuards_Put", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/PutResourceGuard.json" + } + } + }, + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns a ResourceGuard belonging to a resource group.", + "operationId": "ResourceGuards_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuard.json" + } + } + }, + "delete": { + "tags": [ + "ResourceGuards" + ], + "summary": "Deletes a ResourceGuard resource from the resource group.", + "operationId": "ResourceGuards_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/DeleteResourceGuard.json" + } + } + }, + "patch": { + "tags": [ + "ResourceGuards" + ], + "summary": "Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.", + "operationId": "ResourceGuards_Patch", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceRequestInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Patch ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/PatchResourceGuard.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDisableSoftDeleteRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetBackupSecurityPINRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDeleteProtectedItemRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetUpdateProtectedItemRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json" + } + } + } + } + }, + "definitions": { + "AbsoluteDeleteOption": { + "allOf": [ + { + "$ref": "#/definitions/DeleteOption" + } + ], + "description": "Delete option with duration", + "required": [ + "duration", + "objectType" + ], + "title": "AbsoluteDeleteOption", + "type": "object", + "x-ms-discriminator-value": "AbsoluteDeleteOption" + }, + "RecoveryPointsFilters": { + "type": "object", + "properties": { + "restorePointDataStoreId": { + "type": "string" + }, + "isVisible": { + "type": "boolean" + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "extendedInfo": { + "type": "boolean" + }, + "restorePointState": { + "type": "string" + } + } + }, + "AdHocBackupRuleOptions": { + "description": "Adhoc backup rules", + "properties": { + "ruleName": { + "type": "string" + }, + "triggerOption": { + "$ref": "#/definitions/AdhocBackupTriggerOption" + } + }, + "required": [ + "ruleName", + "triggerOption" + ], + "title": "AdHocBackupRuleOptions", + "type": "object" + }, + "AdhocBackupTriggerOption": { + "description": "Adhoc backup trigger option", + "properties": { + "retentionTagOverride": { + "type": "string" + } + }, + "title": "AdhocBackupTriggerOption", + "type": "object" + }, + "AdhocBasedTaggingCriteria": { + "description": "Adhoc backup tagging criteria", + "properties": { + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "title": "AdhocBasedTaggingCriteria", + "type": "object" + }, + "AdhocBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Adhoc trigger context", + "properties": { + "taggingCriteria": { + "$ref": "#/definitions/AdhocBasedTaggingCriteria", + "description": "Tagging Criteria containing retention tag for adhoc backup." + } + }, + "required": [ + "objectType", + "taggingCriteria" + ], + "title": "AdhocBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "AdhocBasedTriggerContext" + }, + "AuthCredentials": { + "description": "Base class for different types of authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "AzureBackupDiscreteRecoveryPoint": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPoint" + } + ], + "description": "Azure backup discrete RecoveryPoint", + "properties": { + "friendlyName": { + "type": "string" + }, + "recoveryPointDataStoresDetails": { + "items": { + "$ref": "#/definitions/RecoveryPointDataStoreDetails" + }, + "type": "array" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + }, + "policyName": { + "type": "string" + }, + "policyVersion": { + "type": "string" + }, + "recoveryPointId": { + "type": "string" + }, + "recoveryPointType": { + "type": "string" + }, + "retentionTagName": { + "type": "string" + }, + "retentionTagVersion": { + "type": "string" + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupDiscreteRecoveryPoint", + "type": "object", + "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint" + }, + "AzureBackupFindRestorableTimeRangesRequest": { + "description": "List Restore Ranges Request", + "required": [ + "sourceDataStoreType" + ], + "type": "object", + "properties": { + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreSourceDataStoreType", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "End time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesRequestResource": { + "description": "List Restore Ranges Request", + "allOf": [ + { + "$ref": "#/definitions/DppWorkerRequest" + } + ], + "properties": { + "content": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest", + "description": "AzureBackupFindRestorableTimeRangesRequestResource content" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponse": { + "description": "List Restore Ranges Response", + "type": "object", + "properties": { + "restorableTimeRanges": { + "description": "Returns the Restore Ranges available on the Backup Instance.", + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTimeRange" + }, + "x-ms-identifiers": [] + }, + "objectType": { + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponseResource": { + "description": "List Restore Ranges Response", + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse", + "description": "AzureBackupFindRestorableTimeRangesResponseResource properties" + } + } + }, + "AzureBackupJob": { + "description": "AzureBackup Job Class", + "properties": { + "activityID": { + "description": "Job Activity Id", + "type": "string" + }, + "backupInstanceFriendlyName": { + "description": "Name of the Backup Instance", + "type": "string" + }, + "backupInstanceId": { + "description": "ARM ID of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataSourceId": { + "description": "ARM ID of the DataSource", + "type": "string" + }, + "dataSourceLocation": { + "description": "Location of the DataSource", + "type": "string" + }, + "dataSourceName": { + "description": "User Friendly Name of the DataSource", + "type": "string" + }, + "dataSourceSetName": { + "description": "Data Source Set Name of the DataSource", + "type": "string" + }, + "dataSourceType": { + "description": "Type of DataSource", + "type": "string" + }, + "duration": { + "description": "Total run time of the job. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "EndTime of the job(in UTC)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorDetails": { + "description": "A List, detailing the errors related to the job", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "extendedInfo": { + "$ref": "#/definitions/JobExtendedInfo", + "description": "Extended Information about the job", + "readOnly": true + }, + "isUserTriggered": { + "description": "Indicated that whether the job is adhoc(true) or scheduled(false)", + "type": "boolean" + }, + "operation": { + "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure", + "type": "string" + }, + "operationCategory": { + "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management", + "type": "string" + }, + "policyId": { + "description": "ARM ID of the policy", + "readOnly": true, + "type": "string" + }, + "policyName": { + "description": "Name of the policy", + "readOnly": true, + "type": "string" + }, + "progressEnabled": { + "description": "Indicated whether progress is enabled for the job", + "type": "boolean" + }, + "progressUrl": { + "description": "Url which contains job's progress", + "readOnly": true, + "type": "string" + }, + "restoreType": { + "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR", + "readOnly": true, + "type": "string" + }, + "sourceResourceGroup": { + "description": "Resource Group Name of the Datasource", + "type": "string" + }, + "sourceSubscriptionID": { + "description": "SubscriptionId corresponding to the DataSource", + "type": "string" + }, + "startTime": { + "description": "StartTime of the job(in UTC)", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription Id of the corresponding backup vault", + "type": "string" + }, + "supportedActions": { + "description": "List of supported actions", + "items": { + "type": "string" + }, + "type": "array" + }, + "vaultName": { + "description": "Name of the vault", + "type": "string" + }, + "etag": { + "type": "string" + }, + "sourceDataStoreName": { + "type": "string" + }, + "destinationDataStoreName": { + "type": "string" + } + }, + "required": [ + "activityID", + "subscriptionId", + "dataSourceId", + "vaultName", + "backupInstanceFriendlyName", + "sourceResourceGroup", + "dataSourceName", + "progressEnabled", + "sourceSubscriptionID", + "dataSourceLocation", + "startTime", + "dataSourceType", + "operationCategory", + "operation", + "status", + "isUserTriggered", + "supportedActions" + ], + "type": "object" + }, + "AzureBackupJobResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "AzureBackup Job Resource Class", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupJob", + "description": "AzureBackupJobResource properties", + "type": "object" + } + }, + "type": "object" + }, + "AzureBackupJobResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of AzureBackup Job resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupJobResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AzureBackupParams": { + "allOf": [ + { + "$ref": "#/definitions/BackupParameters" + } + ], + "description": "Azure backup parameters", + "properties": { + "backupType": { + "description": "BackupType ; Full/Incremental etc", + "type": "string" + } + }, + "required": [ + "backupType", + "objectType" + ], + "title": "AzureBackupParams", + "type": "object", + "x-ms-discriminator-value": "AzureBackupParams" + }, + "AzureBackupRecoveryPoint": { + "description": "Azure backup recoveryPoint", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "AzureBackupRecoveryPoint", + "type": "object" + }, + "AzureBackupRecoveryPointBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "Azure backup recoveryPoint based restore request", + "properties": { + "recoveryPointId": { + "type": "string" + } + }, + "required": [ + "recoveryPointId" + ], + "title": "AzureBackupRecoveryPointBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest" + }, + "AzureBackupRecoveryPointResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "Azure backup recoveryPoint resource", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupRecoveryPoint", + "description": "AzureBackupRecoveryPointResource properties" + } + }, + "title": "AzureBackupRecoveryPointResource" + }, + "AzureBackupRecoveryPointResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "Azure backup recoveryPoint resource list", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + }, + "type": "array" + } + }, + "title": "AzureBackupRecoveryPointResourceList", + "type": "object" + }, + "AzureBackupRehydrationRequest": { + "description": "Azure Backup Rehydrate Request", + "properties": { + "recoveryPointId": { + "description": "Id of the recovery point to be recovered", + "type": "string" + }, + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "recoveryPointId", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRehydrationRequest", + "type": "object" + }, + "AzureBackupRestoreRequest": { + "description": "Azure backup restore request", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + }, + "restoreTargetInfo": { + "$ref": "#/definitions/RestoreTargetInfoBase", + "description": "Gets or sets the restore target information." + }, + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "ArchiveStore", + "SnapshotStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SourceDataStoreType" + } + }, + "sourceResourceId": { + "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.", + "type": "string" + } + }, + "required": [ + "objectType", + "restoreTargetInfo", + "sourceDataStoreType" + ], + "title": "AzureBackupRestoreRequest", + "type": "object" + }, + "AzureBackupRestoreWithRehydrationRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest" + } + ], + "description": "AzureBackup Restore with Rehydration Request", + "properties": { + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "rehydrationPriority", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRestoreWithRehydrationRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest" + }, + "AzureBackupRecoveryTimeBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "AzureBackup RecoveryPointTime Based Restore Request", + "properties": { + "recoveryPointTime": { + "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.", + "type": "string" + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupRecoveryTimeBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest" + }, + "AzureBackupRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure backup rule", + "properties": { + "backupParameters": { + "$ref": "#/definitions/BackupParameters" + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "trigger": { + "$ref": "#/definitions/TriggerContext" + } + }, + "required": [ + "dataStore", + "name", + "objectType", + "trigger" + ], + "title": "AzureBackupRule", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRule" + }, + "AzureOperationalStoreParameters": { + "description": "Parameters for Operational-Tier DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataStoreParameters" + } + ], + "properties": { + "resourceGroupId": { + "description": "Gets or sets the Snapshot Resource Group Uri.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureOperationalStoreParameters" + }, + "AzureRetentionRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure retention rule", + "properties": { + "isDefault": { + "type": "boolean" + }, + "lifecycles": { + "items": { + "$ref": "#/definitions/SourceLifeCycle" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "lifecycles", + "name", + "objectType" + ], + "title": "AzureRetentionRule", + "type": "object", + "x-ms-discriminator-value": "AzureRetentionRule" + }, + "BackupCriteria": { + "description": "BackupCriteria base class", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupCriteria", + "type": "object" + }, + "BackupInstance": { + "description": "Backup Instance", + "required": [ + "dataSourceInfo", + "policyInfo", + "objectType" + ], + "type": "object", + "properties": { + "friendlyName": { + "description": "Gets or sets the Backup Instance friendly name.", + "type": "string" + }, + "dataSourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Gets or sets the data source information." + }, + "dataSourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Gets or sets the data source set information." + }, + "policyInfo": { + "$ref": "#/definitions/PolicyInfo", + "description": "Gets or sets the policy information." + }, + "protectionStatus": { + "$ref": "#/definitions/ProtectionStatusDetails", + "description": "Specifies the protection status of the resource", + "readOnly": true + }, + "currentProtectionState": { + "description": "Specifies the current protection state of the resource", + "enum": [ + "Invalid", + "NotProtected", + "ConfiguringProtection", + "ProtectionConfigured", + "BackupSchedulesSuspended", + "RetentionSchedulesSuspended", + "ProtectionStopped", + "ProtectionError", + "ConfiguringProtectionFailed", + "SoftDeleting", + "SoftDeleted", + "UpdatingProtection" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CurrentProtectionState", + "modelAsString": true + } + }, + "protectionErrorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection error of the resource", + "readOnly": true + }, + "provisioningState": { + "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed", + "type": "string", + "readOnly": true + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + }, + "validationType": { + "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.", + "enum": [ + "ShallowValidation", + "DeepValidation" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationType", + "modelAsString": true + } + }, + "objectType": { + "type": "string" + } + } + }, + "BackupInstanceResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "BackupInstance Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupInstance", + "description": "BackupInstanceResource properties" + } + }, + "title": "BackupInstanceResource" + }, + "BackupInstanceResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "BackupInstance Resource list response", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupInstanceResource" + }, + "type": "array" + } + }, + "title": "BackupInstanceResourceList", + "type": "object" + }, + "BackupParameters": { + "description": "BackupParameters base", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupParameters", + "type": "object" + }, + "BackupPolicy": { + "allOf": [ + { + "$ref": "#/definitions/BaseBackupPolicy" + } + ], + "description": "Rule based backup policy", + "properties": { + "policyRules": { + "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc", + "items": { + "$ref": "#/definitions/BasePolicyRule" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "datasourceTypes", + "policyRules" + ], + "title": "BackupPolicy", + "type": "object", + "x-ms-discriminator-value": "BackupPolicy" + }, + "BackupSchedule": { + "description": "Schedule for backup", + "properties": { + "repeatingTimeIntervals": { + "description": "ISO 8601 repeating time interval format", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeZone": { + "description": "Time zone for a schedule. Example: Pacific Standard Time", + "type": "string" + } + }, + "required": [ + "repeatingTimeIntervals" + ], + "title": "BackupSchedule", + "type": "object" + }, + "BackupVault": { + "description": "Backup Vault", + "properties": { + "provisioningState": { + "description": "Provisioning state of the BackupVault resource", + "enum": [ + "Failed", + "Provisioning", + "Succeeded", + "Unknown", + "Updating" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "resourceMoveState": { + "description": "Resource move state for backup vault", + "enum": [ + "Unknown", + "InProgress", + "PrepareFailed", + "CommitFailed", + "Failed", + "PrepareTimedout", + "CommitTimedout", + "CriticalFailure", + "PartialSuccess", + "MoveSucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResourceMoveState", + "modelAsString": true + } + }, + "resourceMoveDetails": { + "$ref": "#/definitions/ResourceMoveDetails", + "description": "Resource move details for backup vault", + "readOnly": true + }, + "storageSettings": { + "description": "Storage Settings", + "items": { + "$ref": "#/definitions/StorageSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "storageSettings" + ], + "title": "BackupVault", + "type": "object" + }, + "BackupVaultResource": { + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResource" + } + ], + "description": "Backup Vault Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupVault", + "description": "BackupVaultResource properties" + } + }, + "required": [ + "location", + "properties" + ], + "title": "BackupVault Resource" + }, + "BackupVaultResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BackupVault resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupVaultResource" + }, + "type": "array" + } + }, + "title": "BackupVaultResourceList", + "type": "object" + }, + "BaseBackupPolicy": { + "description": "BackupPolicy base", + "discriminator": "objectType", + "properties": { + "datasourceTypes": { + "description": "Type of datasource for the backup management", + "items": { + "type": "string" + }, + "type": "array" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "datasourceTypes", + "objectType" + ], + "title": "BaseBackupPolicy", + "type": "object" + }, + "BaseBackupPolicyResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "BaseBackupPolicy resource", + "properties": { + "properties": { + "$ref": "#/definitions/BaseBackupPolicy", + "description": "BaseBackupPolicyResource properties" + } + }, + "title": "BaseBackupPolicyResource" + }, + "BaseBackupPolicyResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BaseBackupPolicy resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BaseBackupPolicyResource" + }, + "type": "array" + } + }, + "title": "BaseBackupPolicyResourceList", + "type": "object" + }, + "BasePolicyRule": { + "description": "BasePolicy Rule", + "discriminator": "objectType", + "properties": { + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "name", + "objectType" + ], + "title": "BasePolicyRule", + "type": "object" + }, + "CheckNameAvailabilityRequest": { + "description": "CheckNameAvailability Request", + "properties": { + "name": { + "description": "Resource name for which availability needs to be checked", + "type": "string" + }, + "type": { + "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults", + "type": "string" + } + }, + "title": "CheckNameAvailabilityRequest", + "type": "object" + }, + "CheckNameAvailabilityResult": { + "description": "CheckNameAvailability Result", + "properties": { + "message": { + "description": "Gets or sets the message.", + "type": "string" + }, + "nameAvailable": { + "description": "Gets or sets a value indicating whether [name available].", + "type": "boolean" + }, + "reason": { + "description": "Gets or sets the reason.", + "type": "string" + } + }, + "title": "CheckNameAvailabilityResult", + "type": "object" + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "properties": { + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + } + }, + "title": "ClientDiscoveryDisplay", + "type": "object" + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "properties": { + "blobDuration": { + "description": "blob duration of shoebox log specification", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "name": { + "description": "Name for shoebox log specification.", + "type": "string" + } + }, + "title": "ClientDiscoveryForLogSpecification", + "type": "object" + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + }, + "title": "ClientDiscoveryForProperties", + "type": "object" + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "title": "ClientDiscoveryForServiceSpecification", + "type": "object" + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "properties": { + "nextLink": { + "description": "Link to the next chunk of Response.", + "type": "string" + }, + "value": { + "description": "List of available operations.", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "title": "ClientDiscoveryResponse", + "type": "object" + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "properties": { + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "Properties for the given operation." + } + }, + "title": "ClientDiscoveryValueForSingleApi", + "type": "object" + }, + "CloudError": { + "description": "An error response from Azure Backup.", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + }, + "title": "CloudError", + "x-ms-external": true + }, + "CopyOnExpiryOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Copy on Expiry Option", + "required": [ + "objectType" + ], + "title": "CopyOnExpiryOption", + "type": "object", + "x-ms-discriminator-value": "CopyOnExpiryOption" + }, + "CopyOption": { + "description": "Options to copy", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CopyOption", + "type": "object" + }, + "CustomCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Duration based custom options to copy", + "properties": { + "duration": { + "description": "Data copied after given timespan", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CustomCopyOption", + "type": "object", + "x-ms-discriminator-value": "CustomCopyOption" + }, + "Datasource": { + "description": "Datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "Datasource", + "type": "object" + }, + "DatasourceSet": { + "description": "DatasourceSet details of datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "DatasourceSet", + "type": "object" + }, + "DataStoreInfoBase": { + "description": "DataStoreInfo base", + "properties": { + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataStoreTypes" + } + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "dataStoreType", + "objectType" + ], + "title": "DataStoreInfoBase", + "type": "object" + }, + "DataStoreParameters": { + "description": "Parameters for DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + }, + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "DataStoreTypes", + "modelAsString": true + } + } + }, + "discriminator": "objectType" + }, + "Day": { + "description": "Day of the week", + "properties": { + "date": { + "description": "Date of the month", + "format": "int32", + "type": "integer" + }, + "isLast": { + "description": "Whether Date is last date of month", + "type": "boolean" + } + }, + "title": "Day", + "type": "object" + }, + "DeleteOption": { + "description": "Delete Option", + "discriminator": "objectType", + "properties": { + "duration": { + "description": "Duration of deletion after given timespan", + "type": "string" + }, + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "duration", + "objectType" + ], + "title": "DeleteOption", + "type": "object" + }, + "DppIdentityDetails": { + "description": "Identity details", + "properties": { + "principalId": { + "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.", + "readOnly": true, + "type": "string" + }, + "tenantId": { + "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The identityType which can be either SystemAssigned or None", + "type": "string" + } + }, + "title": "DppIdentityDetails", + "type": "object" + }, + "DppBaseResourceList": { + "description": "Base for all lists of V2 resources.", + "type": "object", + "properties": { + "value": { + "description": "List of Dpp resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + } + }, + "DppBaseResource": { + "type": "object", + "description": "Base resource under Microsoft.DataProtection provider namespace", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + } + } + }, + "DppResource": { + "description": "Resource class", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + }, + "title": "DppResource", + "type": "object", + "x-ms-azure-resource": true + }, + "DppResourceList": { + "description": "ListResource", + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "title": "List Resource", + "type": "object" + }, + "DppTrackedResource": { + "properties": { + "eTag": { + "description": "Optional ETag.", + "type": "string" + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + }, + "location": { + "description": "Resource location.", + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/systemData" + } + }, + "type": "object", + "x-ms-azure-resource": true + }, + "systemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The type of identity that last modified the resource." + } + } + }, + "DppTrackedResourceList": { + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "type": "object" + }, + "DppWorkerRequest": { + "type": "object", + "properties": { + "subscriptionId": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "supportedGroupVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "cultureInfo": { + "type": "string" + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "httpMethod": { + "type": "string" + } + } + }, + "Error": { + "description": "The resource management error response.", + "properties": { + "additionalInfo": { + "description": "The error additional info.", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "code": { + "description": "The error code.", + "readOnly": true, + "type": "string" + }, + "details": { + "description": "The error details.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "The error target.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorAdditionalInfo": { + "description": "The resource management error additional info.", + "properties": { + "info": { + "description": "The additional info.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "The additional info type.", + "readOnly": true, + "type": "string" + } + } + }, + "ExportJobsResult": { + "description": "The result for export jobs containing blob details.", + "properties": { + "blobUrl": { + "description": "URL of the blob into which the serialized string of list of jobs is exported.", + "readOnly": true, + "type": "string" + }, + "blobSasKey": { + "description": "SAS key to access the blob.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobUrl": { + "description": "URL of the blob into which the ExcelFile is uploaded.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobSasKey": { + "description": "SAS key to access the ExcelFile blob.", + "readOnly": true, + "type": "string" + } + }, + "title": "ExportJobsResult", + "type": "object" + }, + "FeatureValidationRequest": { + "description": "Base class for feature object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "featureName": { + "description": "backup support feature name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FeatureValidationRequest" + }, + "FeatureValidationRequestBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "FeatureValidationResponse": { + "description": "Feature Validation Response", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "features": { + "description": "Response features", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedFeature" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "FeatureValidationResponse" + }, + "FeatureValidationResponseBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "ImmediateCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Immediate copy Option", + "required": [ + "objectType" + ], + "title": "ImmediateCopyOption", + "type": "object", + "x-ms-discriminator-value": "ImmediateCopyOption" + }, + "InnerError": { + "description": "Inner Error", + "properties": { + "additionalInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Any Key value pairs that can be provided to the client for additional verbose information.", + "type": "object" + }, + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "embeddedInnerError": { + "$ref": "#/definitions/InnerError", + "description": "Child Inner Error, to allow Nesting." + } + }, + "title": "InnerError", + "type": "object" + }, + "ItemLevelRestoreCriteria": { + "description": "Class to contain criteria for item level restore", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ItemLevelRestoreTargetInfo": { + "description": "Restore target info for Item level restore operation", + "required": [ + "restoreCriteria", + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "properties": { + "restoreCriteria": { + "description": "Restore Criteria", + "type": "array", + "items": { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + }, + "x-ms-identifiers": [] + }, + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo" + }, + "JobExtendedInfo": { + "description": "Extended Information about the job", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Job's Additional Details" + }, + "backupInstanceState": { + "description": "State of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataTransferredInBytes": { + "description": "Number of bytes transferred", + "format": "double", + "readOnly": true, + "type": "number" + }, + "recoveryDestination": { + "description": "Destination where restore is done", + "readOnly": true, + "type": "string" + }, + "sourceRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Source Recovery Point", + "readOnly": true + }, + "subTasks": { + "description": "List of Sub Tasks of the job", + "items": { + "$ref": "#/definitions/JobSubTask" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "targetRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Target Recovery Point", + "readOnly": true + } + }, + "type": "object" + }, + "JobSubTask": { + "description": "Details of Job's Sub Task", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Additional details of Sub Tasks" + }, + "taskId": { + "description": "Task Id of the Sub Task", + "format": "int32", + "type": "integer" + }, + "taskName": { + "description": "Name of the Sub Task", + "type": "string" + }, + "taskProgress": { + "description": "Progress of the Sub Task", + "readOnly": true, + "type": "string" + }, + "taskStatus": { + "description": "Status of the Sub Task", + "type": "string" + } + }, + "required": [ + "taskId", + "taskName", + "taskStatus" + ], + "type": "object" + }, + "OperationExtendedInfo": { + "description": "Operation Extended Info", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "title": "OperationExtendedInfo", + "discriminator": "objectType", + "type": "object", + "required": [ + "objectType" + ] + }, + "OperationJobExtendedInfo": { + "allOf": [ + { + "$ref": "#/definitions/OperationExtendedInfo" + } + ], + "description": "Operation Job Extended Info", + "properties": { + "jobId": { + "description": "Arm Id of the job created for this operation.", + "type": "string" + } + }, + "title": "OperationJobExtendedInfo", + "type": "object", + "x-ms-discriminator-value": "OperationJobExtendedInfo" + }, + "OperationResource": { + "description": "Operation Resource", + "properties": { + "endTime": { + "description": "End time of the operation", + "format": "date-time", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section." + }, + "id": { + "description": "It should match what is used to GET the operation result", + "type": "string" + }, + "name": { + "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationExtendedInfo", + "description": "End time of the operation" + }, + "startTime": { + "description": "Start time of the operation", + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + } + }, + "title": "OperationResource", + "type": "object" + }, + "PatchResourceRequestInput": { + "description": "Patch Request content for Microsoft.DataProtection resources", + "properties": { + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + } + }, + "title": "PatchResourceRequestInput", + "type": "object" + }, + "PolicyInfo": { + "description": "Policy Info in backupInstance", + "properties": { + "policyId": { + "type": "string" + }, + "policyVersion": { + "readOnly": true, + "type": "string" + }, + "policyParameters": { + "$ref": "#/definitions/PolicyParameters", + "description": "Policy parameters for the backup instance" + } + }, + "required": [ + "policyId" + ], + "title": "PolicyInfo", + "type": "object" + }, + "PolicyParameters": { + "description": "Parameters in Policy", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "properties": { + "dataStoreParametersList": { + "description": "Gets or sets the DataStore Parameters", + "type": "array", + "items": { + "$ref": "#/definitions/DataStoreParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "ProtectionStatusDetails": { + "description": "Protection status details", + "properties": { + "errorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection status error of the resource" + }, + "status": { + "description": "Specifies the protection status of the resource", + "enum": [ + "ConfiguringProtection", + "ConfiguringProtectionFailed", + "ProtectionConfigured", + "ProtectionStopped", + "SoftDeleted", + "SoftDeleting" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + } + } + }, + "title": "ProtectionStatusDetails", + "type": "object" + }, + "RangeBasedItemLevelRestoreCriteria": { + "description": "Item Level target info for restore operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "minMatchingValue": { + "description": "minimum value for range prefix match", + "type": "string" + }, + "maxMatchingValue": { + "description": "maximum value for range prefix match", + "type": "string" + } + }, + "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria" + }, + "RecoveryPointDataStoreDetails": { + "description": "RecoveryPoint datastore details", + "properties": { + "creationTime": { + "format": "date-time", + "type": "string" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "id": { + "type": "string" + }, + "metaData": { + "type": "string" + }, + "state": { + "type": "string" + }, + "type": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, + "rehydrationExpiryTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "rehydrationStatus": { + "readOnly": true, + "enum": [ + "CREATE_IN_PROGRESS", + "COMPLETED", + "DELETE_IN_PROGRESS", + "DELETED", + "FAILED" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationStatus" + } + } + }, + "title": "RecoveryPointDataStoreDetails", + "type": "object" + }, + "RehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "enum": [ + "Invalid", + "High", + "Standard" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationPriority" + } + }, + "RestoreFilesTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore as files target parameters", + "properties": { + "targetDetails": { + "$ref": "#/definitions/TargetDetails", + "description": "Destination of RestoreAsFiles operation, when destination is not a datasource" + } + }, + "required": [ + "recoveryOption", + "targetDetails" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreFilesTargetInfo" + }, + "RestoreJobRecoveryPointDetails": { + "properties": { + "recoveryPointID": { + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "RestoreTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore target parameters", + "properties": { + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "required": [ + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreTargetInfo" + }, + "RestoreTargetInfoBase": { + "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "recoveryOption": { + "description": "Recovery Option", + "enum": [ + "FailIfExists" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RecoveryOption" + } + }, + "restoreLocation": { + "description": "Target Restore region", + "type": "string" + } + }, + "required": [ + "objectType", + "recoveryOption" + ], + "type": "object" + }, + "ResourceMoveDetails": { + "description": "ResourceMoveDetails will be returned in response to GetResource call from ARM", + "type": "object", + "properties": { + "operationId": { + "description": "CorrelationId of latest ResourceMove operation attempted", + "type": "string" + }, + "startTimeUtc": { + "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.", + "type": "string" + }, + "completionTimeUtc": { + "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.", + "type": "string" + }, + "sourceResourcePath": { + "description": "ARM resource path of source resource", + "type": "string" + }, + "targetResourcePath": { + "description": "ARM resource path of target resource used in latest ResourceMove operation", + "type": "string" + } + } + }, + "RestorableTimeRange": { + "required": [ + "startTime", + "endTime" + ], + "type": "object", + "properties": { + "startTime": { + "description": "Start time for the available restore range", + "type": "string" + }, + "endTime": { + "description": "End time for the available restore range", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "RetentionTag": { + "description": "Retention tag", + "properties": { + "eTag": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "tagName": { + "description": "Retention Tag Name to relate it to retention rule.", + "type": "string" + } + }, + "required": [ + "tagName" + ], + "title": "RetentionTag", + "type": "object" + }, + "ScheduleBasedBackupCriteria": { + "allOf": [ + { + "$ref": "#/definitions/BackupCriteria" + } + ], + "description": "Schedule based backup criteria", + "properties": { + "absoluteCriteria": { + "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum", + "items": { + "enum": [ + "AllBackup", + "FirstOfDay", + "FirstOfMonth", + "FirstOfWeek", + "FirstOfYear" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AbsoluteMarker" + } + }, + "type": "array" + }, + "daysOfMonth": { + "description": "This is day of the month from 1 to 28 other wise last of month", + "items": { + "$ref": "#/definitions/Day" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "daysOfTheWeek": { + "description": "It should be Sunday/Monday/T..../Saturday", + "items": { + "enum": [ + "Friday", + "Monday", + "Saturday", + "Sunday", + "Thursday", + "Tuesday", + "Wednesday" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DayOfWeek" + } + }, + "type": "array" + }, + "monthsOfYear": { + "description": "It should be January/February/....../December", + "items": { + "enum": [ + "April", + "August", + "December", + "February", + "January", + "July", + "June", + "March", + "May", + "November", + "October", + "September" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Month" + } + }, + "type": "array" + }, + "scheduleTimes": { + "description": "List of schedule times for backup", + "items": { + "format": "date-time", + "type": "string" + }, + "type": "array" + }, + "weeksOfTheMonth": { + "description": "It should be First/Second/Third/Fourth/Last", + "items": { + "enum": [ + "First", + "Fourth", + "Last", + "Second", + "Third" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WeekNumber" + } + }, + "type": "array" + } + }, + "required": [ + "objectType" + ], + "title": "ScheduleBasedBackupCriteria", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedBackupCriteria" + }, + "ScheduleBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Schedule based trigger context", + "properties": { + "schedule": { + "$ref": "#/definitions/BackupSchedule", + "description": "Schedule for this backup" + }, + "taggingCriteria": { + "description": "List of tags that can be applicable for given schedule.", + "items": { + "$ref": "#/definitions/TaggingCriteria" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "objectType", + "schedule", + "taggingCriteria" + ], + "title": "ScheduleBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedTriggerContext" + }, + "SecretStoreBasedAuthCredentials": { + "description": "Secret store based authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + } + ], + "properties": { + "secretStoreResource": { + "$ref": "#/definitions/SecretStoreResource", + "description": "Secret store resource" + } + }, + "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials" + }, + "SecretStoreResource": { + "description": "Class representing a secret store resource.", + "required": [ + "secretStoreType" + ], + "type": "object", + "properties": { + "uri": { + "description": "Uri to get to the resource", + "type": "string" + }, + "secretStoreType": { + "description": "Gets or sets the type of secret store", + "enum": [ + "Invalid", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretStoreType", + "modelAsString": true + } + }, + "value": { + "description": "Gets or sets value stored in secret store resource", + "type": "string" + } + } + }, + "SourceLifeCycle": { + "description": "Source LifeCycle", + "properties": { + "deleteAfter": { + "$ref": "#/definitions/DeleteOption" + }, + "sourceDataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "targetDataStoreCopySettings": { + "items": { + "$ref": "#/definitions/TargetCopySetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "deleteAfter", + "sourceDataStore" + ], + "title": "SourceLifeCycle", + "type": "object" + }, + "StorageSetting": { + "description": "Storage setting", + "properties": { + "datastoreType": { + "description": "Gets or sets the type of the datastore.", + "enum": [ + "ArchiveStore", + "SnapshotStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingStoreTypes" + } + }, + "type": { + "description": "Gets or sets the type.", + "enum": [ + "GeoRedundant", + "LocallyRedundant" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingTypes" + } + } + }, + "title": "StorageSetting", + "type": "object" + }, + "SupportedFeature": { + "description": "Elements class for feature request", + "type": "object", + "properties": { + "featureName": { + "description": "support feature type.", + "type": "string" + }, + "supportStatus": { + "description": "feature support status", + "enum": [ + "Invalid", + "NotSupported", + "AlphaPreview", + "PrivatePreview", + "PublicPreview", + "GenerallyAvailable" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureSupportStatus", + "modelAsString": true + } + }, + "exposureControlledFeatures": { + "description": "support feature type.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SyncBackupInstanceRequest": { + "description": "Sync BackupInstance Request", + "type": "object", + "properties": { + "syncType": { + "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases", + "enum": [ + "Default", + "ForceResync" + ], + "type": "string", + "x-ms-enum": { + "name": "SyncType", + "modelAsString": true + } + } + } + }, + "TaggingCriteria": { + "description": "Tagging criteria", + "properties": { + "criteria": { + "description": "Criteria which decides whether the tag can be applied to a triggered backup.", + "items": { + "$ref": "#/definitions/BackupCriteria" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "isDefault": { + "description": "Specifies if tag is default.", + "type": "boolean" + }, + "taggingPriority": { + "description": "Retention Tag priority.", + "format": "int64", + "type": "integer" + }, + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "required": [ + "isDefault", + "tagInfo", + "taggingPriority" + ], + "title": "TaggingCriteria", + "type": "object" + }, + "TargetCopySetting": { + "description": "Target copy settings", + "properties": { + "copyAfter": { + "$ref": "#/definitions/CopyOption", + "description": "It can be CustomCopyOption or ImmediateCopyOption." + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase", + "description": "Info of target datastore" + } + }, + "required": [ + "copyAfter", + "dataStore" + ], + "title": "TargetCopySetting", + "type": "object" + }, + "TargetDetails": { + "description": "Class encapsulating target details, used where the destination is not a datasource", + "properties": { + "filePrefix": { + "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them", + "type": "string" + }, + "restoreTargetLocationType": { + "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}", + "enum": [ + "Invalid", + "AzureBlobs", + "AzureFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreTargetLocationType", + "modelAsString": true + } + }, + "url": { + "description": "Url denoting the restore destination. It can point to container / file share etc", + "type": "string" + } + }, + "required": [ + "filePrefix", + "restoreTargetLocationType", + "url" + ], + "type": "object" + }, + "TriggerBackupRequest": { + "description": "Trigger backup request", + "properties": { + "backupRuleOptions": { + "$ref": "#/definitions/AdHocBackupRuleOptions", + "description": "Name for the Rule of the Policy which needs to be applied for this backup" + } + }, + "required": [ + "backupRuleOptions" + ], + "title": "TriggerBackupRequest", + "type": "object" + }, + "TriggerContext": { + "description": "Trigger context", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "TriggerContext", + "type": "object" + }, + "UserFacingError": { + "description": "Error object used by layers that have access to localized content, and propagate that to user", + "properties": { + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "details": { + "description": "Additional related Errors", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Inner Error" + }, + "isRetryable": { + "description": "Whether the operation will be retryable or not", + "type": "boolean" + }, + "isUserError": { + "description": "Whether the operation is due to a user error or service error", + "type": "boolean" + }, + "properties": { + "description": "Any key value pairs that can be injected inside error object", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "type": "string" + }, + "recommendedAction": { + "description": "RecommendedAction � localized.", + "items": { + "type": "string" + }, + "type": "array" + }, + "target": { + "description": "Target of the error.", + "type": "string" + } + }, + "type": "object" + }, + "ValidateForBackupRequest": { + "description": "Validate for backup request", + "properties": { + "backupInstance": { + "$ref": "#/definitions/BackupInstance" + } + }, + "required": [ + "backupInstance" + ], + "title": "ValidateForBackupRequest", + "type": "object" + }, + "ValidateRestoreRequestObject": { + "description": "Validate restore request object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + } + }, + "required": [ + "restoreRequestObject" + ], + "title": "ValidateRestoreRequestObject", + "type": "object" + }, + "ResourceGuard": { + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the BackupVault resource", + "enum": [ + "Failed", + "Provisioning", + "Succeeded", + "Unknown", + "Updating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "allowAutoApprovals": { + "description": "This flag indicates whether auto approval is allowed or not.", + "type": "boolean", + "readOnly": true + }, + "resourceGuardOperations": { + "description": "{readonly} List of operation details those are protected by the ResourceGuard resource", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardOperation" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "vaultCriticalOperationExclusionList": { + "description": "List of critical operations which are not protected by this resourceGuard", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "description": { + "description": "Description about the pre-req steps to perform all the critical operations.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceGuardOperation": { + "description": "This class contains all the details about a critical operation.", + "type": "object", + "properties": { + "vaultCriticalOperation": { + "description": "Name of the critical operation.", + "type": "string", + "readOnly": true + }, + "requestResourceType": { + "description": "Type of resource request.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceGuardResource": { + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResource" + } + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceGuard", + "description": "ResourceGuardResource properties" + } + } + }, + "ResourceGuardResourceList": { + "description": "List of ResourceGuard resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardResource" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the backup vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the backup vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json new file mode 100644 index 000000000000..c6776ad90731 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/DeleteBackupInstance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "backupInstanceName": "testInstance1", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json new file mode 100644 index 000000000000..9aad52fe25ab --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "Blob-Backup", + "vaultName": "ZBlobBackupVaultBVTD3", + "backupInstanceName": "zblobbackuptestsa58", + "api-version": "2022-01-01", + "parameters": { + "sourceDataStoreType": "OperationalStore", + "startTime": "2020-10-17T23:28:17.6829685Z", + "endTime": "2021-02-24T00:35:17.6829685Z" + } + }, + "responses": { + "200": { + "body": { + "id": "zblobbackuptestsa58", + "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges", + "properties": { + "restorableTimeRanges": [ + { + "startTime": "2021-02-23T18:33:51.6349708Z", + "endTime": "2021-02-24T00:35:17.0000000Z", + "objectType": "RestorableTimeRange" + } + ], + "objectType": "AzureBackupFindRestorableTimeRangesResponse" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstance.json new file mode 100644 index 000000000000..40bf5e6ae140 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json new file mode 100644 index 000000000000..8b72d93dfcb6 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "backupInstanceName": "testInstance1", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1", + "name": "testInstance1", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "testInstance1", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "ConfiguringProtection" + }, + "provisioningState": "Provisioned", + "objectType": "BackupInstance" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json new file mode 100644 index 000000000000..d7bbec0d5ad4 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/GetRecoveryPoint.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListBackupInstances.json new file mode 100644 index 000000000000..08e71a731b31 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListBackupInstances.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json new file mode 100644 index 000000000000..d0044bdca4a0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ListRecoveryPoints.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + }, + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/PutBackupInstance.json new file mode 100644 index 000000000000..3c793017357a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/PutBackupInstance.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "properties": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "dataSourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "validationType": "ShallowValidation" + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + }, + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioned", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeBackups.json new file mode 100644 index 000000000000..dc8146bddd29 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeProtection.json new file mode 100644 index 000000000000..dc8146bddd29 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ResumeProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/StopProtection.json new file mode 100644 index 000000000000..dc8146bddd29 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/StopProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SuspendBackups.json new file mode 100644 index 000000000000..dc8146bddd29 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SuspendBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json new file mode 100644 index 000000000000..c18ecec3a98a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/SyncBackupInstance.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2022-01-01", + "parameters": { + "syncType": "Default" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerBackup.json new file mode 100644 index 000000000000..f8595584e1bc --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerBackup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "backupRuleOptions": { + "ruleName": "BackupWeekly", + "triggerOption": { + "retentionTagOverride": "yearly" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json new file mode 100644 index 000000000000..56fc35e36032 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRehydrate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestore.json new file mode 100644 index 000000000000..1b1a7b56ff71 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestore.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json new file mode 100644 index 000000000000..d3ef823888e8 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "targetDetails": { + "url": "https://teststorage.blob.core.windows.net/restoretest", + "filePrefix": "restoredblob", + "restoreTargetLocationType": "AzureBlobs" + }, + "restoreLocation": "southeastasia", + "recoveryOption": "FailIfExists", + "objectType": "RestoreFilesTargetInfo" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json new file mode 100644 index 000000000000..89fe8883b66a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRestoreWithRehydrationRequest", + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "restoreLocation": "southeastasia" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateForBackup.json new file mode 100644 index 000000000000..2a45bd6b9ebe --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateForBackup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "backupInstance": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "dataSourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateRestore.json new file mode 100644 index 000000000000..bc07a1477b2f --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/BackupInstanceOperations/ValidateRestore.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2022-01-01", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2022-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/CheckfeatureSupport.json new file mode 100644 index 000000000000..d096b32a2cec --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/CheckfeatureSupport.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "api-version": "2022-01-01", + "parameters": { + "featureType": "DataSourceType", + "objectType": "FeatureValidationRequest" + } + }, + "responses": { + "200": { + "body": { + "featureType": "DataSourceType", + "features": [ + { + "featureName": "Microsoft.Storage/storageAccounts/blobServices", + "supportStatus": "PrivatePreview", + "exposureControlledFeatures": [] + }, + { + "featureName": "Microsoft.DBforPostgreSQL/servers/databases", + "supportStatus": "PublicPreview", + "exposureControlledFeatures": [] + } + ], + "objectType": "FeatureValidationResponse" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationResult.json new file mode 100644 index 000000000000..ec9f10d0abbd --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationResult.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatus.json new file mode 100644 index 000000000000..28a6d28d16b4 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatus.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusRGContext.json new file mode 100644 index 000000000000..d90f994b592c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusRGContext.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusVaultContext.json new file mode 100644 index 000000000000..a644cf66fbff --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/GetOperationStatusVaultContext.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetExportJobsOperationResult.json new file mode 100644 index 000000000000..76b07c02f1eb --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetExportJobsOperationResult.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000", + "blobSasKey": "someKey", + "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx", + "excelFileBlobSasKey": "someKey" + } + }, + "202": { + "headers": { + "Retry-After": 60, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-01-01" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetJob.json new file mode 100644 index 000000000000..32274c8def96 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/GetJob.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap", + "extendedInfo": { + "subTasks": [ + { + "taskId": 1, + "taskName": "Trigger Backup", + "taskStatus": "Started" + } + ], + "additionalDetails": { + "RetentionTag": "Default", + "PolicyRuleName": "BackupWeekly", + "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9" + } + } + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/ListJobs.json new file mode 100644 index 000000000000..9796153c5d08 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/ListJobs.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4", + "policyName": "jakavetPolicy2", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb4", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T05:00:08.1746833Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002", + "name": "8989416e-7573-4836-8cf1-0e90954f1002", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5", + "policyName": "jakavetPolicy3", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb5", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T18:00:03.6660733Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3", + "policyName": "jakavetPolicy1", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb3", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T11:11:50.5595259Z", + "endTime": "2021-03-17T11:14:02.5319646Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Succeeded", + "isUserTriggered": true, + "supportedActions": [ + "" + ], + "duration": "00:02:11.9724387", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097", + "name": "43252662-1b43-44fd-a856-0055665cb097", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/TriggerExportJobs.json new file mode 100644 index 000000000000..6d20fbc56bbe --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/JobCRUD/TriggerExportJobs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2022-01-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2022-01-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/Operations/List.json new file mode 100644 index 000000000000..bed286fba98f --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/Operations/List.json @@ -0,0 +1,533 @@ +{ + "parameters": { + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataProtection/locations/getBackupStatus/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Create a Backup Instance", + "description": "Creates a Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Delete Backup Instance", + "description": "Deletes the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instance Details", + "description": "Returns details of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instances", + "description": "Returns all Backup Instances" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Backup Backup Instance", + "description": "Performs Backup on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Sync Backup Instance", + "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Stop Protection of Backup Instance", + "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Suspend Backups of Backup Instance", + "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Protection of Backup Instance", + "description": "Resume protection of a ProtectionStopped BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Backups of Backup Instance", + "description": "Resume Backups for a BackupsSuspended BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Validate for Restore of Backup Instance", + "description": "Validates for Restore of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Restore Backup Instance", + "description": "Triggers restore on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Create Backup Policy", + "description": "Creates Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Delete Backup Policy", + "description": "Deletes the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policy details", + "description": "Returns details of the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policies", + "description": "Returns all Backup Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get the list of ResourceGuard proxies for a resource", + "description": "Get the list of ResourceGuard proxies for a resource" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get ResourceGuard proxy", + "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Create ResourceGuard proxy", + "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Delete ResourceGuard proxy", + "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation", + "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Point Details", + "description": "Returns details of the Recovery Point" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Returns all Recovery Points" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Restorable Time Ranges", + "operation": "Find Restorable Time Ranges", + "description": "Finds Restorable Time Ranges" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Operation Result of a Patch Operation for a Backup Vault", + "description": "Gets Operation Result of a Patch Operation for a Backup Vault" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Check if the requested BackupVault Name is Available", + "description": "Checks if the requested BackupVault Name is Available" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Resource Group", + "description": "Gets list of Backup Vaults in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Subscription", + "description": "Gets list of Backup Vaults in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Create ResourceGuard", + "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard", + "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Delete ResourceGuard", + "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Resource Group", + "description": "Gets list of ResourceGuards in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Subscription", + "description": "Gets list of ResourceGuards in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Update ResourceGuard", + "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard operation request info", + "description": "Gets ResourceGuard operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard default operation request info", + "description": "Gets ResourceGuard default operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Validate if a feature is supported", + "description": "Validates if a feature is supported" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Validate Backup", + "operation": "Validate for backup of Backup Instance", + "description": "Validates for backup of Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Jobs", + "description": "Get Jobs list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Job Object", + "description": "Get Job details" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/register/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Register Resource Provider", + "description": "Registers subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/unregister/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Unregister Resource Provider", + "description": "Unregisters subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/operations/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "List of Operations", + "description": "Operation returns the list of Operations for a Resource Provider" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json new file mode 100644 index 000000000000..d1312df81541 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2022-01-01", + "parameters": { + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json new file mode 100644 index 000000000000..33d39866d507 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/DeleteBackupPolicy.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2022-01-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/GetBackupPolicy.json new file mode 100644 index 000000000000..33353e47c602 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/GetBackupPolicy.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/ListBackupPolicy.json new file mode 100644 index 000000000000..51fdefa76381 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/PolicyCRUD/ListBackupPolicy.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json new file mode 100644 index 000000000000..73d66e471d10 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json new file mode 100644 index 000000000000..3cc7c07ccc78 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json new file mode 100644 index 000000000000..66bd63d7c53a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json new file mode 100644 index 000000000000..30af533f5f89 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json new file mode 100644 index 000000000000..b0f0725ecdba --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json new file mode 100644 index 000000000000..821e23712b7f --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json new file mode 100644 index 000000000000..d3e698a19829 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json new file mode 100644 index 000000000000..1301fb61cc16 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuard.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "ResourceGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json new file mode 100644 index 000000000000..ac135db6bc74 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json new file mode 100644 index 000000000000..86e6e1e9781c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json new file mode 100644 index 000000000000..cb04963e695e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json new file mode 100644 index 000000000000..ef171152deb7 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json new file mode 100644 index 000000000000..13846a22c7fb --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json new file mode 100644 index 000000000000..5e2ba9df74de --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json new file mode 100644 index 000000000000..24f0f8dc1531 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json new file mode 100644 index 000000000000..44e57a962f84 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json new file mode 100644 index 000000000000..87ee7b9a8e0c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PatchResourceGuard.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01", + "parameters": { + "tags": { + "newKey": "newVal" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json new file mode 100644 index 000000000000..f974dc3f28b1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/ResourceGuardCRUD/PutResourceGuard.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2022-01-01", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json new file mode 100644 index 000000000000..f0637267d17a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "location": "westus", + "api-version": "2022-01-01", + "parameters": { + "type": "Microsoft.DataProtection/BackupVaults", + "name": "swaggerExample" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/DeleteBackupVault.json new file mode 100644 index 000000000000..55238b12de05 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/DeleteBackupVault.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVault.json new file mode 100644 index 000000000000..068e4b834fa0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVault.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json new file mode 100644 index 000000000000..f71a71837cfb --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultWithMSI.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json new file mode 100644 index 000000000000..0bf3ec2f4ec1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json new file mode 100644 index 000000000000..969ff632929d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetOperationResultPatch.json new file mode 100644 index 000000000000..d2e346703fda --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/GetOperationResultPatch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2022-01-01" + }, + "responses": { + "200": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + }, + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PatchBackupVault.json new file mode 100644 index 000000000000..226272488682 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PatchBackupVault.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "parameters": { + "tags": { + "newKey": "newVal" + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + } + }, + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "newKey": "newVal" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVault.json new file mode 100644 index 000000000000..fd55810b7380 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVault.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "None" + }, + "properties": { + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + } + }, + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json new file mode 100644 index 000000000000..32af968f02c1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2022-01-01/examples/VaultCRUD/PutBackupVaultWithMSI.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2022-01-01", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "systemAssigned" + }, + "properties": { + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2022-01-01" + } + }, + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md index 106523b85458..d92a3f7a7b19 100644 --- a/specification/dataprotection/resource-manager/readme.md +++ b/specification/dataprotection/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for DataProtection. - - --- + ## Getting Started + To build the SDK for DataProtection, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,28 +15,28 @@ To build the SDK for DataProtection, simply [Install AutoRest](https://aka.ms/au To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the DataProtection API. ``` yaml title: Data Protection Client description: Open API 2.0 Specs for Azure Data Protection service openapi-type: arm -tag: package-2021-07 +tag: package-2022-01 csharp-sdks-folder: ./Generated/CSharp python-sdks-folder: ./Generated/Python go-sdk-folder: ./Generated/Golang - license-header: MICROSOFT_MIT ``` ### Validations + Run validations when `--validate` is specified on command line ``` yaml $(validate) @@ -46,6 +46,15 @@ semantic-validator: true message-format: json ``` + +### Tag: package-2022-01 + +These settings apply only when `--tag=package-2022-01` is specified on the command line. + +``` yaml $(tag) == 'package-2022-01' +input-file: + - Microsoft.DataProtection/stable/2022-01-01/dataprotection.json +``` ### Tag: package-2021-10-preview These settings apply only when `--tag=package-2021-10-preview` is specified on the command line. @@ -101,8 +110,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -123,13 +132,12 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_data_protection'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. -```yaml $(csharp) +``` yaml $(csharp) csharp: azure-arm: true payload-flattening-threshold: 1 @@ -150,4 +158,3 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) - diff --git a/specification/dnsresolver/resource-manager/readme.typescript.md b/specification/dnsresolver/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..8350bcd8178e --- /dev/null +++ b/specification/dnsresolver/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-dnsresolver" + output-folder: "$(typescript-sdks-folder)/sdk/dnsresolver/arm-dnsresolver" + generate-metadata: true +``` diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json index c3c70fec0a0c..575b013842bc 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json @@ -60,6 +60,7 @@ "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", "properties": { "defaultAction": "Deny", + "publicNetworkAccess": "Enabled", "virtualNetworkRules": [ { "subnet": { diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json index 4fa99e95009f..58e2288ff950 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json @@ -12,7 +12,8 @@ "name": "default", "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", "properties": { - "defaultAction": "Deny", + "defaultAction": "Allow", + "publicNetworkAccess": "Enabled", "virtualNetworkRules": [ { "subnet": { diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json index 136cb2586121..32e393cf1187 100644 --- a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json @@ -294,6 +294,7 @@ { "in": "formData", "name": "file", + "description": "Input test file", "required": true, "type": "file" } @@ -999,6 +1000,7 @@ { "in": "formData", "name": "file", + "description": "Artifact to upload as input for test", "required": true, "type": "file" } diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/attachedDataNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/attachedDataNetwork.json new file mode 100644 index 000000000000..d920c2071589 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/attachedDataNetwork.json @@ -0,0 +1,504 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage attached data network resources in mobile network attached to a particular packet core instance", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks/{attachedDataNetworkName}": { + "delete": { + "tags": [ + "AttachedDataNetwork" + ], + "operationId": "AttachedDataNetworks_Delete", + "description": "Deletes the specified attached data network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/AttachedDataNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete attached data network resource": { + "$ref": "./examples/AttachedDataNetworkDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AttachedDataNetwork" + ], + "operationId": "AttachedDataNetworks_Get", + "description": "Gets information about the specified attached data network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/AttachedDataNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting attached data network resource.", + "schema": { + "$ref": "#/definitions/AttachedDataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get attached data network": { + "$ref": "./examples/AttachedDataNetworkGet.json" + } + } + }, + "put": { + "tags": [ + "AttachedDataNetwork" + ], + "operationId": "AttachedDataNetworks_CreateOrUpdate", + "description": "Creates or updates an attached data network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/AttachedDataNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedDataNetwork" + }, + "description": "Parameters supplied to the create or update attached data network operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting attached data network resource.", + "schema": { + "$ref": "#/definitions/AttachedDataNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting attached data network resource.", + "schema": { + "$ref": "#/definitions/AttachedDataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create attached data network": { + "$ref": "./examples/AttachedDataNetworkCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AttachedDataNetwork" + ], + "operationId": "AttachedDataNetworks_UpdateTags", + "description": "Updates an attached data network update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/AttachedDataNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update attached data network tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting attached data network resource.", + "schema": { + "$ref": "#/definitions/AttachedDataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update attached data network tags": { + "$ref": "./examples/AttachedDataNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}/attachedDataNetworks": { + "get": { + "tags": [ + "AttachedDataNetwork" + ], + "operationId": "AttachedDataNetworks_ListByPacketCoreDataPlane", + "description": "Gets all the data networks associated with a packet core data plane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of attached data network resources.", + "schema": { + "$ref": "#/definitions/AttachedDataNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List attached data networks in a data plane": { + "$ref": "./examples/AttachedDataNetworkListByPacketCoreDataPlane.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AttachedDataNetwork": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttachedDataNetworkPropertiesFormat", + "description": "Data network properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Attached data network resource." + }, + "AttachedDataNetworkPropertiesFormat": { + "description": "Data network properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the attached data network resource." + }, + "userPlaneDataInterface": { + "$ref": "./common.json#/definitions/InterfaceProperties", + "description": "The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface." + }, + "naptConfiguration": { + "$ref": "#/definitions/NaptConfiguration", + "description": "The Network Address and Port Translation configuration.\nIf not specified the attached data network uses a default NAPT configuration with NAPT enabled." + }, + "userEquipmentAddressPoolPrefix": { + "type": "array", + "items": { + "$ref": "./ts29571.json#/definitions/Ipv4AddrMask" + }, + "minItems": 1, + "uniqueItems": true, + "description": "The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session.\nAt least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size." + }, + "userEquipmentStaticAddressPoolPrefix": { + "type": "array", + "items": { + "$ref": "./ts29571.json#/definitions/Ipv4AddrMask" + }, + "minItems": 1, + "uniqueItems": true, + "description": "The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session.\nThe mapping of static IP to sim is configured in staticIpConfiguration on the sim resource.\nAt least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size." + } + }, + "required": [ + "userPlaneDataInterface" + ] + }, + "AttachedDataNetworkListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AttachedDataNetwork" + }, + "description": "A list of data networks in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for attached data network API service call." + }, + "NaptConfiguration": { + "description": "The Network Address and Port Translation settings to use for the attached data network.", + "type": "object", + "properties": { + "enabled": { + "description": "Whether NAPT is enabled for connections to this attachedDataNetwork.", + "$ref": "#/definitions/NaptEnabled" + }, + "portRange": { + "description": "Range of port numbers to use as translated ports on each translated address.\nIf not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.)", + "$ref": "#/definitions/PortRange" + }, + "portReuseHoldTime": { + "description": "The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.", + "$ref": "#/definitions/PortReuseHoldTimes" + }, + "pinholeLimits": { + "description": "Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65536, + "default": 65536 + }, + "pinholeTimeouts": { + "description": "Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.", + "$ref": "#/definitions/PinholeTimeouts" + } + } + }, + "NaptEnabled": { + "description": "Whether Network Address and Port Translation is enabled.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NaptEnabled", + "modelAsString": true + }, + "default": "Enabled" + }, + "PortRange": { + "description": "Range of port numbers to use as translated ports on each translated address.\nIf not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.)", + "type": "object", + "properties": { + "minPort": { + "description": "The minimum port number", + "type": "integer", + "format": "int32", + "minimum": 1024, + "maximum": 65535, + "default": 1024 + }, + "maxPort": { + "description": "The maximum port number", + "type": "integer", + "format": "int32", + "minimum": 1024, + "maximum": 65535, + "default": 65535 + } + } + }, + "PortReuseHoldTimes": { + "description": "The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.", + "type": "object", + "properties": { + "tcp": { + "description": "Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 120 + }, + "udp": { + "description": "Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 60 + } + } + }, + "PinholeTimeouts": { + "description": "Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.", + "type": "object", + "properties": { + "tcp": { + "description": "Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 7440 + }, + "udp": { + "description": "Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 300 + }, + "icmp": { + "description": "Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2.", + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 60 + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/common.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/common.json new file mode 100644 index 000000000000..8f3cb0a086d1 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/common.json @@ -0,0 +1,317 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the virtual network functions deployed using mobile network", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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": {}, + "definitions": { + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to another sub resource.", + "x-ms-azure-resource": true + }, + "DataNetworkResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$", + "description": "Data Network resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to a Data Network resource.", + "x-ms-azure-resource": true + }, + "AttachedDataNetworkResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][cC][oO][nN][tT][rR][oO][lL][pP][lL][aA][nN][eE][sS]/[^/?#]+/[pP][aA][cC][kK][eE][tT][cC][oO][rR][eE][dD][aA][tT][aA][pP][lL][aA][nN][eE][sS]/[^/?#]+/[aA][tT][tT][aA][cC][hH][eE][dD][dD][aA][tT][aA][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$", + "description": "Attached Data Network resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to an Attached Data Network resource.", + "x-ms-azure-resource": true + }, + "MobileNetworkResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+$", + "description": "Mobile Network resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to a Mobile Network resource.", + "x-ms-azure-resource": true + }, + "ServiceResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[sS][eE][rR][vV][iI][cC][eE][sS]/[^/?#]+$", + "description": "Service resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to a Service resource.", + "x-ms-azure-resource": true + }, + "SimPolicyResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[sS][iI][mM][pP][oO][lL][iI][cC][iI][eE][sS]/[^/?#]+$", + "description": "SIM Policy resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to a SIM Policy resource.", + "x-ms-azure-resource": true + }, + "SliceResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK]/[mM][oO][bB][iI][lL][eE][nN][eE][tT][wW][oO][rR][kK][sS]/[^/?#]+/[sS][lL][iI][cC][eE][sS]/[^/?#]+$", + "description": "Slice resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to a Slice resource.", + "x-ms-azure-resource": true + }, + "CustomLocationResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[^/?#]+/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/?#]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[eE][xX][tT][eE][nN][dD][eE][dD][lL][oO][cC][aA][tT][iI][oO][nN]/[cC][uU][sS][tT][oO][mM][lL][oO][cC][aA][tT][iI][oO][nN][sS]/[^/?#]+$", + "description": "Azure ARC custom location resource ID." + } + }, + "required": [ + "id" + ], + "description": "Reference to an Azure ARC custom location resource.", + "x-ms-azure-resource": true + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Unknown", + "Succeeded", + "Accepted", + "Deleting", + "Failed", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ConfigurationState": { + "type": "string", + "readOnly": true, + "description": "The configuration state of the resource - complete or incomplete.", + "enum": [ + "Incomplete", + "Complete" + ], + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true + } + }, + "InterfaceProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine." + } + }, + "required": [ + "name" + ], + "description": "Interface properties" + } + }, + "parameters": { + "AttachedDataNetworkNameParameter": { + "name": "attachedDataNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])*(\\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])*)*$", + "maxLength": 64, + "description": "The name of the attached data network.", + "x-ms-parameter-location": "method" + }, + "DataNetworkNameParameter": { + "name": "dataNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])*(\\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])*)*$", + "maxLength": 64, + "description": "The name of the mobile network dataNetwork.", + "x-ms-parameter-location": "method" + }, + "MobileNetworkNameParameter": { + "name": "mobileNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the mobile network.", + "x-ms-parameter-location": "method" + }, + "PacketCoreControlPlaneNameParameter": { + "name": "packetCoreControlPlaneName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the packet core control plane.", + "x-ms-parameter-location": "method" + }, + "PacketCoreDataPlaneNameParameter": { + "name": "packetCoreDataPlaneName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the packet core data plane.", + "x-ms-parameter-location": "method" + }, + "ServiceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the service. You must not use any of the following reserved strings - `default`, `requested` or `service`", + "x-ms-parameter-location": "method" + }, + "SimNameParameter": { + "name": "simName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the SIM.", + "x-ms-parameter-location": "method" + }, + "SimPolicyNameParameter": { + "name": "simPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the SIM policy.", + "x-ms-parameter-location": "method" + }, + "SiteNameParameter": { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the mobile network site.", + "x-ms-parameter-location": "method" + }, + "SliceNameParameter": { + "name": "sliceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64, + "description": "The name of the mobile network slice.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/dataNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/dataNetwork.json new file mode 100644 index 000000000000..3eded83b497d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/dataNetwork.json @@ -0,0 +1,349 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage data network resources in mobile network to a particular packet core instance", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks/{dataNetworkName}": { + "delete": { + "tags": [ + "DataNetworks" + ], + "operationId": "DataNetworks_Delete", + "description": "Deletes the specified mobile network dataNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/DataNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete mobile network dataNetwork": { + "$ref": "./examples/DataNetworkDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DataNetworks" + ], + "operationId": "DataNetworks_Get", + "description": "Gets information about the specified mobile network dataNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/DataNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting mobile network dataNetwork resource.", + "schema": { + "$ref": "#/definitions/DataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get mobile network dataNetwork": { + "$ref": "./examples/DataNetworkGet.json" + } + } + }, + "put": { + "tags": [ + "DataNetworks" + ], + "operationId": "DataNetworks_CreateOrUpdate", + "description": "Creates or updates a mobile network dataNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/DataNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataNetwork" + }, + "description": "Parameters supplied to the create or update mobile network dataNetwork operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network dataNetwork resource.", + "schema": { + "$ref": "#/definitions/DataNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting mobile network dataNetwork resource.", + "schema": { + "$ref": "#/definitions/DataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create mobile network dataNetwork": { + "$ref": "./examples/DataNetworkCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "DataNetworks" + ], + "operationId": "DataNetworks_UpdateTags", + "description": "Update data network tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/DataNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update data network tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting data network resource.", + "schema": { + "$ref": "#/definitions/DataNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update data network tags": { + "$ref": "./examples/DataNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/dataNetworks": { + "get": { + "tags": [ + "DataNetworks" + ], + "operationId": "DataNetworks_ListByMobileNetwork", + "description": "Lists all dataNetworks in the mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of mobile network resources.", + "schema": { + "$ref": "#/definitions/DataNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List mobile network dataNetworks in a mobile network": { + "$ref": "./examples/DataNetworkListByMobileNetwork.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DataNetwork": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataNetworkPropertiesFormat", + "description": "Data network properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Data network resource." + }, + "DataNetworkPropertiesFormat": { + "description": "Data network properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the data network resource." + }, + "description": { + "type": "string", + "description": "An optional description for this data network." + } + } + }, + "DataNetworkListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataNetwork" + }, + "description": "A list of data networks in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for data network API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkCreate.json new file mode 100644 index 000000000000..72e1229139df --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkCreate.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "packetCoreDataPlaneName": "TestPacketCoreDP", + "attachedDataNetworkName": "TestAttachedDataNetwork", + "parameters": { + "location": "eastus", + "properties": { + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestAttachedDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoresControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork", + "type": "Microsoft.MobileNetwork/attachedDataNetwork", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + }, + "201": { + "body": { + "name": "TestAttachedDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoresControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork", + "type": "Microsoft.MobileNetwork/attachedDataNetwork", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkDelete.json new file mode 100644 index 000000000000..ccc8421c5fc4 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "packetCoreDataPlaneName": "TestPacketCoreDP", + "attachedDataNetworkName": "TestAttachedDataNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkGet.json new file mode 100644 index 000000000000..29a2f6442bb2 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "packetCoreDataPlaneName": "TestPacketCoreDP", + "attachedDataNetworkName": "TestAttachedDataNetwork" + }, + "responses": { + "200": { + "body": { + "name": "TestAttachedDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork", + "type": "Microsoft.MobileNetwork/attachedDataNetwork", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkListByPacketCoreDataPlane.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkListByPacketCoreDataPlane.json new file mode 100644 index 000000000000..d409b1e2c971 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkListByPacketCoreDataPlane.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "packetCoreDataPlaneName": "TestPacketCoreDP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestAttachedDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork", + "type": "Microsoft.MobileNetwork/attachedDataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkUpdateTags.json new file mode 100644 index 000000000000..ca2c71c0074d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/AttachedDataNetworkUpdateTags.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "packetCoreDataPlaneName": "TestPacketCoreDP", + "attachedDataNetworkName": "TestAttachedDataNetwork", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestAccessPoint", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork", + "type": "Microsoft.MobileNetwork/attachedDataNetwork", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "userPlaneDataInterface": { + "name": "N6" + }, + "naptConfiguration": { + "enabled": "Enabled", + "portRange": { + "minPort": 1024, + "maxPort": 65535 + }, + "portReuseHoldTime": { + "tcp": 120, + "udp": 60 + }, + "pinholeLimits": 65536, + "pinholeTimeouts": { + "tcp": 7440, + "udp": 300, + "icmp": 60 + } + }, + "userEquipmentAddressPoolPrefix": [ + "2.2.0.0/16" + ], + "userEquipmentStaticAddressPoolPrefix": [ + "2.4.0.0/16" + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkCreate.json new file mode 100644 index 000000000000..f92356dd37c8 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "dataNetworkName": "testDataNetwork", + "parameters": { + "location": "eastus", + "properties": { + "description": "myFavouriteDataNetwork" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testDataNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks/dataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "myFavouriteDataNetwork" + } + } + }, + "201": { + "body": { + "name": "testDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testDataNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks/dataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Created", + "description": "myFavouriteDataNetwork" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkDelete.json new file mode 100644 index 000000000000..74273c019eea --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "dataNetworkName": "testDataNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkGet.json new file mode 100644 index 000000000000..fa10e27807a3 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "dataNetworkName": "testDataNetwork" + }, + "responses": { + "200": { + "body": { + "name": "testDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testDataNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks/dataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "myFavouriteDataNetwork" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkListByMobileNetwork.json new file mode 100644 index 000000000000..d8be43bb4a2e --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkListByMobileNetwork.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testDataNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks/dataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "myFavouriteDataNetwork" + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkUpdateTags.json new file mode 100644 index 000000000000..848b8566f735 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/DataNetworkUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "dataNetworkName": "testDataNetwork", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDataNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testDataNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks/dataNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "description": "myFavouriteDataNetwork" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkCreate.json new file mode 100644 index 000000000000..a3b6980e6eed --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkCreate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "parameters": { + "location": "eastus", + "properties": { + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + }, + "201": { + "body": { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Created", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkDelete.json new file mode 100644 index 000000000000..bc243734e6f2 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkGet.json new file mode 100644 index 000000000000..ee6a1f284fc2 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListByResourceGroup.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListByResourceGroup.json new file mode 100644 index 000000000000..9d6cf7b79495 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListBySubscription.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListBySubscription.json new file mode 100644 index 000000000000..dee5455ce125 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkUpdateTags.json new file mode 100644 index 000000000000..172f5d5c8bc2 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/MobileNetworkUpdateTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testMobileNetwork", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork", + "type": "Microsoft.MobileNetwork/mobileNetworks", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "publicLandMobileNetworkIdentifier": { + "mcc": "001", + "mnc": "01" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/OperationList.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..bf0b13da63a5 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/OperationList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2022-01-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "isDataAction": false, + "name": "Microsoft.MobileNetwork/mobileNetworks/read", + "display": { + "provider": "Microsoft.MobileNetwok", + "resource": "MobileNetwork", + "operation": "Get mobileNetwork", + "description": "Gets mobileNetwork" + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneCreate.json new file mode 100644 index 000000000000..19fab5dc428e --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneCreate.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "parameters": { + "location": "eastus", + "properties": { + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + }, + "201": { + "body": { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneDelete.json new file mode 100644 index 000000000000..977f65d9c444 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneGet.json new file mode 100644 index 000000000000..8c64620b3024 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP" + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListByResourceGroup.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListByResourceGroup.json new file mode 100644 index 000000000000..70c2ad0e9e4d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListBySubscription.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListBySubscription.json new file mode 100644 index 000000000000..3f00b62d3d27 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneListBySubscription.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneUpdateTags.json new file mode 100644 index 000000000000..b4ed6b07d97e --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreControlPlaneUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "TestPacketCoreCP", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreCP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP", + "type": "Microsoft.MobileNetwork/packetCoreControlPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "customLocation": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation" + }, + "coreNetworkTechnology": "5GC", + "version": "0.2.0", + "controlPlaneAccessInterface": { + "name": "N2" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneCreate.json new file mode 100644 index 000000000000..8aeb6a0e90a7 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneCreate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "testPacketCoreCP", + "packetCoreDataPlaneName": "testPacketCoreDP", + "parameters": { + "location": "eastus", + "properties": { + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreDP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP", + "type": "Microsoft.MobileNetwork/packetCoreDataPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + }, + "201": { + "body": { + "name": "TestPacketCoreDP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP", + "type": "Microsoft.MobileNetwork/packetCoreDataPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneDelete.json new file mode 100644 index 000000000000..b13adba16941 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "testPacketCoreCP", + "packetCoreDataPlaneName": "testPacketCoreDP" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneGet.json new file mode 100644 index 000000000000..70801bceeacf --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "testPacketCoreCP", + "packetCoreDataPlaneName": "testPacketCoreDP" + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreDP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP", + "type": "Microsoft.MobileNetwork/packetCoreDataPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneListByPacketCoreControlPlane.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneListByPacketCoreControlPlane.json new file mode 100644 index 000000000000..0a8305e7c899 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneListByPacketCoreControlPlane.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "testPacketCoreCP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPacketCoreDP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP", + "type": "Microsoft.MobileNetwork/packetCoreDataPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneUpdateTags.json new file mode 100644 index 000000000000..5f3c262df4a0 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/PacketCoreDataPlaneUpdateTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "packetCoreControlPlaneName": "testPacketCoreCP", + "packetCoreDataPlaneName": "testPacketCoreDP", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPacketCoreDP", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP", + "type": "Microsoft.MobileNetwork/packetCoreDataPlane", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "userPlaneAccessInterface": { + "name": "N3" + } + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceCreate.json new file mode 100644 index 000000000000..05d53cf91bdc --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceCreate.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "serviceName": "TestService", + "parameters": { + "location": "eastus", + "properties": { + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService", + "type": "Microsoft.MobileNetwork/service", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService", + "type": "Microsoft.MobileNetwork/service", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceDelete.json new file mode 100644 index 000000000000..ddb7ca65b211 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "serviceName": "TestService" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceGet.json new file mode 100644 index 000000000000..7484d32e8bc7 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceGet.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "serviceName": "TestService" + }, + "responses": { + "200": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService", + "type": "Microsoft.MobileNetwork/service", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceListByMobileNetwork.json new file mode 100644 index 000000000000..6114df3792d0 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceListByMobileNetwork.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "testResourceGroupName", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService", + "type": "Microsoft.MobileNetwork/service", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceUpdateTags.json new file mode 100644 index 000000000000..7097aadc2e24 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/ServiceUpdateTags.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "serviceName": "TestService", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestService", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/TestService", + "type": "Microsoft.MobileNetwork/service", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "servicePrecedence": 255, + "serviceQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "pccRules": [ + { + "ruleName": "default-rule", + "rulePrecedence": 255, + "ruleQosPolicy": { + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "maximumBitRate": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + } + }, + "trafficControl": "Enabled", + "serviceDataFlowTemplates": [ + { + "templateName": "IP-to-server", + "direction": "Uplink", + "protocol": [ + "ip" + ], + "remoteIpList": [ + "10.3.4.0/24" + ], + "ports": [] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimCreate.json new file mode 100644 index 000000000000..60011b2b2892 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimCreate.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "simName": "testSim", + "parameters": { + "location": "testLocation", + "properties": { + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "authenticationKey": "00000000000000000000000000000000", + "operatorKeyCode": "00000000000000000000000000000000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sims/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sims/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimDelete.json new file mode 100644 index 000000000000..5ba22c946102 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "testResourceGroupName", + "simName": "testSim" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimGet.json new file mode 100644 index 000000000000..c731818ffd4f --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "testResourceGroupName", + "simName": "testSimName" + }, + "responses": { + "200": { + "body": { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sim/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimIdListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimIdListByMobileNetwork.json new file mode 100644 index 000000000000..d37c16fc3e24 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimIdListByMobileNetwork.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg", + "mobileNetworkName": "testMobileNetworkName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.MobileNetwork/sims/testSim" + } + ], + "nextLink": "nextLink" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.MobileNetwork/locations/testLocation/operationStatuses/testOperation?api-version=2022-01-01-preview" + }, + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.MobileNetwork/sims/testSim" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListByResourceGroup.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListByResourceGroup.json new file mode 100644 index 000000000000..ad0772a10161 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sims/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListBySubscription.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListBySubscription.json new file mode 100644 index 000000000000..b0719c1beff2 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sims/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyCreate.json new file mode 100644 index 000000000000..5d33446cf24f --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyCreate.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "simPolicyName": "testPolicy", + "parameters": { + "location": "eastus", + "properties": { + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy", + "type": "Microsoft.MobileNetwork/simPolicy", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy", + "type": "Microsoft.MobileNetwork/simPolicy", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyDelete.json new file mode 100644 index 000000000000..6961ec19e541 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "simPolicyName": "testPolicy" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyGet.json new file mode 100644 index 000000000000..af8f3e09ada1 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyGet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "simPolicyName": "testPolicy" + }, + "responses": { + "200": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy", + "type": "Microsoft.MobileNetwork/simPolicy", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyListByMobileNetwork.json new file mode 100644 index 000000000000..0e4618fa905e --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyListByMobileNetwork.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "testResourceGroupName", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy", + "type": "Microsoft.MobileNetwork/simPolicy", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Accepted", + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyUpdateTags.json new file mode 100644 index 000000000000..ed579f213fa9 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimPolicyUpdateTags.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "simPolicyName": "testPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/testPolicy", + "type": "Microsoft.MobileNetwork/simPolicy", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "registrationTimer": 3240, + "ueAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "defaultSlice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "sliceConfigurations": [ + { + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "defaultDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "dataNetworkConfigurations": [ + { + "dataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork" + }, + "sessionAmbr": { + "uplink": "500 Mbps", + "downlink": "1 Gbps" + }, + "5qi": 9, + "allocationAndRetentionPriorityLevel": 9, + "preemptionCapability": "NotPreempt", + "preemptionVulnerability": "Preemptable", + "defaultSessionType": "IPv4", + "additionalAllowedSessionTypes": [], + "allowedServices": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimUpdateTags.json new file mode 100644 index 000000000000..cc552993a9a7 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SimUpdateTags.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "simName": "testSim", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSim", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/sim/testSim", + "type": "Microsoft.MobileNetwork/sims", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "configurationState": "Complete", + "integratedCircuitCardIdentifier": "8900000000000000000", + "internationalMobileSubscriberIdentity": "00000", + "mobileNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork" + }, + "deviceType": "Video camera", + "simPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy" + }, + "staticIpConfiguration": [ + { + "attachedDataNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork" + }, + "slice": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice" + }, + "staticIp": { + "ipv4Address": "2.4.0.1" + } + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteCreate.json new file mode 100644 index 000000000000..868687dd1658 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteCreate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "siteName": "testSite", + "parameters": { + "location": "testLocation", + "properties": { + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite", + "type": "Microsoft.MobileNetwork/mobileNetworks/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + }, + "201": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite", + "type": "Microsoft.MobileNetwork/mobileNetworks/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Created", + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteDelete.json new file mode 100644 index 000000000000..94daca1487e1 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "siteName": "testSite" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteGet.json new file mode 100644 index 000000000000..099e3e2dc691 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "siteName": "testSite" + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite", + "type": "Microsoft.MobileNetwork/mobileNetworks/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteListByMobileNetwork.json new file mode 100644 index 000000000000..aadf407a6609 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteListByMobileNetwork.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite", + "type": "Microsoft.MobileNetwork/mobileNetworks/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "properties": { + "provisioningState": "Succeeded", + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteUpdateTags.json new file mode 100644 index 000000000000..a916672af02e --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SiteUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "siteName": "testSite", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSite", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/sites/testSite", + "type": "Microsoft.MobileNetwork/mobileNetworks/sites", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "testLocation", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "networkFunctions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf" + } + ] + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceCreate.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceCreate.json new file mode 100644 index 000000000000..6db3f6ee1f4f --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceCreate.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "sliceName": "testSlice", + "parameters": { + "location": "eastus", + "properties": { + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSlice", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice", + "type": "Microsoft.MobileNetwork/mobileNetworks/slices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + }, + "201": { + "body": { + "name": "testSlice", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice", + "type": "Microsoft.MobileNetwork/mobileNetworks/slices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Created", + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceDelete.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceDelete.json new file mode 100644 index 000000000000..77f8fe3f302d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "sliceName": "testSlice" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceGet.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceGet.json new file mode 100644 index 000000000000..6755cb50059d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "sliceName": "testSlice" + }, + "responses": { + "200": { + "body": { + "name": "testSlice", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice", + "type": "Microsoft.MobileNetwork/mobileNetworks/slices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceListByMobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceListByMobileNetwork.json new file mode 100644 index 000000000000..d325429fab16 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceListByMobileNetwork.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testSlice", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice", + "type": "Microsoft.MobileNetwork/mobileNetworks/slices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + ] + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceUpdateTags.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceUpdateTags.json new file mode 100644 index 000000000000..716b442a88ab --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/examples/SliceUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2022-01-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "mobileNetworkName": "testMobileNetwork", + "sliceName": "testSlice", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testSlice", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice", + "type": "Microsoft.MobileNetwork/mobileNetworks/slices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "snssai": { + "sst": 1, + "sd": "1abcde" + }, + "description": "myFavouriteSlice" + } + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/mobileNetwork.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/mobileNetwork.json new file mode 100644 index 000000000000..17d3975d5c77 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/mobileNetwork.json @@ -0,0 +1,1186 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage mobile network resources", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}": { + "delete": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_Delete", + "description": "Deletes the specified mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete mobile network": { + "$ref": "./examples/MobileNetworkDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_Get", + "description": "Gets information about the specified mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting mobile network resource.", + "schema": { + "$ref": "#/definitions/MobileNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get mobile network": { + "$ref": "./examples/MobileNetworkGet.json" + } + } + }, + "put": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_CreateOrUpdate", + "description": "Creates or updates a mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MobileNetwork" + }, + "description": "Parameters supplied to the create or update mobile network operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network resource.", + "schema": { + "$ref": "#/definitions/MobileNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting mobile network resource.", + "schema": { + "$ref": "#/definitions/MobileNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create mobile network": { + "$ref": "./examples/MobileNetworkCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_UpdateTags", + "description": "Updates a mobile network update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update mobile network tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network resource.", + "schema": { + "$ref": "#/definitions/MobileNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update mobile network tags": { + "$ref": "./examples/MobileNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/mobileNetworks": { + "get": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_ListBySubscription", + "description": "Lists all the mobile networks in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of mobile network resources.", + "schema": { + "$ref": "#/definitions/MobileNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List mobile networks in a subscription": { + "$ref": "./examples/MobileNetworkListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks": { + "get": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_ListByResourceGroup", + "description": "Lists all the mobile networks in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of mobile network resources.", + "schema": { + "$ref": "#/definitions/MobileNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List mobile networks in resource group": { + "$ref": "./examples/MobileNetworkListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/listSimIds": { + "post": { + "tags": [ + "MobileNetworks" + ], + "operationId": "MobileNetworks_ListSimIds", + "description": "List sim ids under a mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "List sim profile ids successful.", + "schema": { + "$ref": "#/definitions/SimIdListResult" + } + }, + "202": { + "description": "Accepted. Returns an operation URI that can be queried to find the current state of the operation.", + "schema": { + "$ref": "#/definitions/SimIdListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List sim profile ids by network": { + "$ref": "./examples/SimIdListByMobileNetwork.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites/{siteName}": { + "delete": { + "tags": [ + "Sites" + ], + "operationId": "Sites_Delete", + "description": "Deletes the specified mobile network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete mobile network site": { + "$ref": "./examples/SiteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_Get", + "description": "Gets information about the specified mobile network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting mobile network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get mobile network site": { + "$ref": "./examples/SiteGet.json" + } + } + }, + "put": { + "tags": [ + "Sites" + ], + "operationId": "Sites_CreateOrUpdate", + "description": "Creates or updates a mobile network site.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Site" + }, + "description": "Parameters supplied to the create or update mobile network site operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting mobile network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create mobile network site": { + "$ref": "./examples/SiteCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Sites" + ], + "operationId": "Sites_UpdateTags", + "description": "Updates a site update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SiteNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network site tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network site resource.", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update mobile network site tags": { + "$ref": "./examples/SiteUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/sites": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_ListByMobileNetwork", + "description": "Lists all sites in the mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of mobile network resources.", + "schema": { + "$ref": "#/definitions/SiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List mobile network sites in a mobile network": { + "$ref": "./examples/SiteListByMobileNetwork.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims/{simName}": { + "delete": { + "tags": [ + "Sims" + ], + "operationId": "Sims_Delete", + "description": "Deletes the specified sim.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete sim": { + "$ref": "./examples/SimDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Sims" + ], + "operationId": "Sims_Get", + "description": "Gets information about the specified sim.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting sim resource.", + "schema": { + "$ref": "#/definitions/Sim" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get sim": { + "$ref": "./examples/SimGet.json" + } + } + }, + "put": { + "tags": [ + "Sims" + ], + "operationId": "Sims_CreateOrUpdate", + "description": "Creates or updates a Sim.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Sim" + }, + "description": "Parameters supplied to the create or update sim operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting sim resource.", + "schema": { + "$ref": "#/definitions/Sim" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting sim resource.", + "schema": { + "$ref": "#/definitions/Sim" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create sim": { + "$ref": "./examples/SimCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Sims" + ], + "operationId": "Sims_UpdateTags", + "description": "Updates a sim update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update sim tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting sim resource.", + "schema": { + "$ref": "#/definitions/Sim" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update sim tags": { + "$ref": "./examples/SimUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/sims": { + "get": { + "tags": [ + "Sims" + ], + "operationId": "Sims_ListBySubscription", + "description": "Gets all the sims in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of sim resources.", + "schema": { + "$ref": "#/definitions/SimListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List sims in a subscription": { + "$ref": "./examples/SimListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/sims": { + "get": { + "tags": [ + "Sims" + ], + "operationId": "Sims_ListByResourceGroup", + "description": "Gets all the Sims in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of sim resources.", + "schema": { + "$ref": "#/definitions/SimListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List sims in a resource group": { + "$ref": "./examples/SimListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "MobileNetwork": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MobileNetworkPropertiesFormat", + "description": "Mobile network properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Mobile network resource." + }, + "MobileNetworkPropertiesFormat": { + "type": "object", + "description": "Mobile network properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the mobile network resource." + }, + "publicLandMobileNetworkIdentifier": { + "$ref": "./ts29571.json#/definitions/PlmnId", + "description": "The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks." + }, + "serviceKey": { + "type": "string", + "readOnly": true, + "description": "The mobile network resource identifier" + } + }, + "required": [ + "publicLandMobileNetworkIdentifier" + ] + }, + "MobileNetworkListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MobileNetwork" + }, + "description": "A list of mobile networks in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for mobile networks API service call." + }, + "Sim": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SimPropertiesFormat", + "description": "Sim Properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Sim resource." + }, + "SimPropertiesFormat": { + "type": "object", + "description": "Sim properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the sim resource." + }, + "configurationState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ConfigurationState", + "description": "The configuration state of the sim resource - complete or incomplete." + }, + "internationalMobileSubscriberIdentity": { + "type": "string", + "pattern": "^[0-9]{5,15}$", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "The International Mobile Subscriber Identity (IMSI) for the sim." + }, + "integratedCircuitCardIdentifier": { + "type": "string", + "pattern": "^89[0-9]{17,18}$", + "description": "The Integrated Circuit Card ID (ICC Id) for the sim." + }, + "authenticationKey": { + "type": "string", + "pattern": "^[0-9a-fA-F]{32}$", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "The ki value for the sim." + }, + "operatorKeyCode": { + "type": "string", + "pattern": "^[0-9a-fA-F]{32}$", + "x-ms-secret": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "The Opc value for the sim." + }, + "mobileNetwork": { + "$ref": "./common.json#/definitions/MobileNetworkResourceId", + "description": "Mobile network that this sim belongs to" + }, + "deviceType": { + "type": "string", + "description": "An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value." + }, + "simPolicy": { + "$ref": "./common.json#/definitions/SimPolicyResourceId", + "description": "The simPolicy used by this sim." + }, + "staticIpConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/SimStaticIpProperties" + }, + "x-ms-identifiers": [], + "minItems": 1, + "uniqueItems": true, + "description": "A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}." + } + }, + "required": [ + "internationalMobileSubscriberIdentity" + ] + }, + "SimStaticIpProperties": { + "type": "object", + "description": "Static IP configuration for a sim, scoped to a particular attached data network and slice.", + "properties": { + "attachedDataNetwork": { + "$ref": "./common.json#/definitions/AttachedDataNetworkResourceId", + "description": "The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address." + }, + "slice": { + "$ref": "./common.json#/definitions/SliceResourceId", + "description": "The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address." + }, + "staticIp": { + "type": "object", + "description": "The static IP configuration for the sim to use at the defined network scope.", + "properties": { + "ipv4Address": { + "$ref": "./ts29571.json#/definitions/Ipv4Addr", + "description": "The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork." + } + } + } + } + }, + "SimIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/SubResource" + }, + "description": "A list of sim profile ids in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list sim ids API service call." + }, + "SimListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Sim" + }, + "description": "A list of Sims in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list Sims API service call." + }, + "Site": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SitePropertiesFormat", + "description": "Site properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Site resource." + }, + "SitePropertiesFormat": { + "type": "object", + "description": "Site properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the site resource. **TODO**: Confirm if this is needed" + }, + "networkFunctions": { + "type": "array", + "items": { + "$ref": "./common.json#/definitions/SubResource" + }, + "description": "An array of ids of the network functions deployed on the site, maintained by the user." + } + } + }, + "SiteListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Site" + }, + "description": "A list of sites in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for sites API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/operation.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/operation.json new file mode 100644 index 000000000000..f500f0ac82bd --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/operation.json @@ -0,0 +1,134 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the operations.", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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.MobileNetwork/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of the operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK Returns a list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Operations": { + "$ref": "./examples/OperationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Operation": { + "properties": { + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation applies to data-plane." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "readOnly": true, + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.MobileNetwork" + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed: Registration definition, registration assignment etc." + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + }, + "type": "object", + "description": "Object that describes a single Microsoft.MobileNetwork operation." + }, + "OperationList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [], + "description": "List of Microsoft.MobileNetwork operations." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "type": "object", + "description": "List of the operations." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreControlPlane.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreControlPlane.json new file mode 100644 index 000000000000..b9028042834a --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreControlPlane.json @@ -0,0 +1,396 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage packet core control plane resources", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}": { + "delete": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_Delete", + "description": "Deletes the specified packet core control plane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet core control plane": { + "$ref": "./examples/PacketCoreControlPlaneDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_Get", + "description": "Gets information about the specified packet core control plane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting packet core control plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet core control plane": { + "$ref": "./examples/PacketCoreControlPlaneGet.json" + } + } + }, + "put": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_CreateOrUpdate", + "description": "Creates or updates a PacketCoreControlPlane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCoreControlPlane" + }, + "description": "Parameters supplied to the create or update packet core control plane operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting packet core control plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlane" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting packet core control plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet core control plane": { + "$ref": "./examples/PacketCoreControlPlaneCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_UpdateTags", + "description": "Updates a PacketCoreControlPlane update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update PacketCoreControlPlane tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting packet core control plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update packet core control plane tags": { + "$ref": "./examples/PacketCoreControlPlaneUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes": { + "get": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_ListBySubscription", + "description": "Lists all the packetCoreControlPlanes in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of packet core control plane resources.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlaneListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List packet core control planes in a subscription": { + "$ref": "./examples/PacketCoreControlPlaneListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes": { + "get": { + "tags": [ + "PacketCoreControlPlanes" + ], + "operationId": "PacketCoreControlPlanes_ListByResourceGroup", + "description": "Lists all the packetCoreControlPlanes in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of packet core control plane resources.", + "schema": { + "$ref": "#/definitions/PacketCoreControlPlaneListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List packet core control planes in resource group": { + "$ref": "./examples/PacketCoreControlPlaneListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PacketCoreControlPlane": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCoreControlPlanePropertiesFormat", + "description": "Packet core control plane Properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Packet core control plane resource." + }, + "PacketCoreControlPlanePropertiesFormat": { + "description": "PacketCoreControlPlane properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the packet core control plane resource." + }, + "mobileNetwork": { + "$ref": "./common.json#/definitions/MobileNetworkResourceId", + "description": "Mobile network that this packet core control plane belongs to" + }, + "customLocation": { + "$ref": "./common.json#/definitions/CustomLocationResourceId", + "description": "Azure ARC custom location where the packet core is deployed." + }, + "coreNetworkTechnology": { + "$ref": "./ts29571.json#/definitions/CoreNetworkType", + "description": "The core network technology generation." + }, + "version": { + "type": "string", + "description": "The version of the packet core software that is deployed." + }, + "controlPlaneAccessInterface": { + "$ref": "./common.json#/definitions/InterfaceProperties", + "description": "The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface." + } + }, + "required": [ + "mobileNetwork", + "controlPlaneAccessInterface" + ] + }, + "PacketCoreControlPlaneListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCoreControlPlane" + }, + "description": "A list of packet core control planes in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for packet core control planes API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreDataPlane.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreDataPlane.json new file mode 100644 index 000000000000..f27cf6943846 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreDataPlane.json @@ -0,0 +1,355 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage packet core data plane resources", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes/{packetCoreDataPlaneName}": { + "delete": { + "tags": [ + "PacketCoreDataPlanes" + ], + "operationId": "PacketCoreDataPlanes_Delete", + "description": "Deletes the specified packet core data plane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet core data plane": { + "$ref": "./examples/PacketCoreDataPlaneDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PacketCoreDataPlanes" + ], + "operationId": "PacketCoreDataPlanes_Get", + "description": "Gets information about the specified packet core data plane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting packet core data plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreDataPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet core data plane": { + "$ref": "./examples/PacketCoreDataPlaneGet.json" + } + } + }, + "put": { + "tags": [ + "PacketCoreDataPlanes" + ], + "operationId": "PacketCoreDataPlanes_CreateOrUpdate", + "description": "Creates or updates a PacketCoreDataPlane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCoreDataPlane" + }, + "description": "Parameters supplied to the create or update packet core data plane operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting packet core data plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreDataPlane" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting packet core data plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreDataPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet core data plane": { + "$ref": "./examples/PacketCoreDataPlaneCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "PacketCoreDataPlanes" + ], + "operationId": "PacketCoreDataPlanes_UpdateTags", + "description": "Updates a PacketCoreDataPlane update tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreDataPlaneNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update PacketCoreDataPlane tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting packet core data plane resource.", + "schema": { + "$ref": "#/definitions/PacketCoreDataPlane" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update packet core data plane tags": { + "$ref": "./examples/PacketCoreDataPlaneUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/{packetCoreControlPlaneName}/packetCoreDataPlanes": { + "get": { + "tags": [ + "PacketCoreDataPlanes" + ], + "operationId": "PacketCoreDataPlanes_ListByPacketCoreControlPlane", + "description": "Lists all the packetCoreDataPlanes associated with a packetCoreControlPlane.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/PacketCoreControlPlaneNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of packet core data plane resources.", + "schema": { + "$ref": "#/definitions/PacketCoreDataPlaneListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List packet core data planes in a control plane": { + "$ref": "./examples/PacketCoreDataPlaneListByPacketCoreControlPlane.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PacketCoreDataPlane": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCoreDataPlanePropertiesFormat", + "description": "Packet core data plane Properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Packet core data plane resource." + }, + "PacketCoreDataPlanePropertiesFormat": { + "description": "PacketCoreDataPlane properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the packet core data plane resource." + }, + "userPlaneAccessInterface": { + "$ref": "./common.json#/definitions/InterfaceProperties", + "description": "The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface." + } + }, + "required": [ + "userPlaneAccessInterface" + ] + }, + "PacketCoreDataPlaneListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCoreDataPlane" + }, + "description": "A list of packet core data planes in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for packet core data planes API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/service.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/service.json new file mode 100644 index 000000000000..2d6211306436 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/service.json @@ -0,0 +1,541 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage service resources", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services/{serviceName}": { + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "description": "Deletes the specified service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete service": { + "$ref": "./examples/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "description": "Gets information about the specified service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting service resource.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get service": { + "$ref": "./examples/ServiceGet.json" + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_CreateOrUpdate", + "description": "Creates or updates a Service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Service" + }, + "description": "Parameters supplied to the create or update service operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting service resource.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting service resource.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create service": { + "$ref": "./examples/ServiceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Service" + ], + "operationId": "Services_UpdateTags", + "description": "Update service tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update service tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting service resource.", + "schema": { + "$ref": "#/definitions/Service" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update service tags": { + "$ref": "./examples/ServiceUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_ListByMobileNetwork", + "description": "Gets all the services in a mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of service resources.", + "schema": { + "$ref": "#/definitions/ServiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List services in a mobile network": { + "$ref": "./examples/ServiceListByMobileNetwork.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Service": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServicePropertiesFormat", + "description": "Service Properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Service resource." + }, + "ServicePropertiesFormat": { + "description": "Service properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the service resource.", + "$ref": "./common.json#/definitions/ProvisioningState" + }, + "servicePrecedence": { + "description": "A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 255 + }, + "serviceQosPolicy": { + "description": "The QoS policy to use for packets matching this service. This can be overridden for particular flows using the ruleQosPolicy field in a PccRuleConfiguration. If this field is null then the UE's simPolicy will define the QoS settings.", + "$ref": "#/definitions/QosPolicy" + }, + "pccRules": { + "description": "The set of PCC Rules that make up this service.", + "type": "array", + "items": { + "$ref": "#/definitions/PccRuleConfiguration" + }, + "x-ms-identifiers": [], + "minItems": 1, + "uniqueItems": true + } + }, + "required": [ + "servicePrecedence", + "pccRules" + ] + }, + "PccRuleConfiguration": { + "description": "PCC rule configuration", + "type": "object", + "properties": { + "ruleName": { + "description": "The name of the rule. This must be unique within the parent Service. You must not use any of the following reserved strings - `default`, `requested` or `service`.", + "type": "string", + "pattern": "^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64 + }, + "rulePrecedence": { + "description": "A precedence value that is used to decide between PCC Rules when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all PCC Rules configured in the Mobile Network.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 255 + }, + "ruleQosPolicy": { + "description": "The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings.", + "$ref": "#/definitions/PccRuleQosPolicy" + }, + "trafficControl": { + "description": "Determines whether flows that match this PCC Rule are permitted.", + "$ref": "#/definitions/TrafficControlPermission", + "default": "Enabled" + }, + "serviceDataFlowTemplates": { + "description": "The set of service data flow templates to use for this PCC Rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceDataFlowTemplate" + }, + "x-ms-identifiers": [], + "minItems": 1, + "uniqueItems": true + } + }, + "required": [ + "ruleName", + "rulePrecedence", + "serviceDataFlowTemplates" + ] + }, + "ServiceDataFlowTemplate": { + "description": "Service data flow (SDF) template", + "type": "object", + "properties": { + "templateName": { + "description": "The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`.", + "type": "string", + "pattern": "^(?!(default|requested|service)$)[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "maxLength": 64 + }, + "direction": { + "description": "The direction of this flow.", + "$ref": "#/definitions/SdfDirection" + }, + "protocol": { + "description": "A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified.", + "type": "array", + "items": { + "type": "string", + "pattern": "^(ip|[0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$" + }, + "minItems": 1, + "uniqueItems": true + }, + "remoteIpList": { + "description": "The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24).", + "type": "array", + "items": { + "type": "string", + "pattern": "^(any|(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2])))$", + "description": "IPv4 address mask or value `any`", + "example": "198.51.0.0/16" + }, + "minItems": 1, + "uniqueItems": true + }, + "ports": { + "description": "The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as -. For example: [`8080`, `8082-8085`].", + "type": "array", + "items": { + "type": "string", + "pattern": "^([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(-([1-9]|[1-9][0-9]{1,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$" + }, + "uniqueItems": true + } + }, + "required": [ + "templateName", + "direction", + "protocol", + "remoteIpList" + ] + }, + "ServiceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Service" + }, + "description": "A list of Services." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for Services API service call." + }, + "QosPolicy": { + "description": "QoS policy", + "type": "object", + "properties": { + "5qi": { + "description": "QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This must not be a standardized 5QI value selecting a GBR (Guaranteed Bit Rate) QoS. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5Qi parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values.", + "$ref": "./ts29571.json#/definitions/5QiPriorityLevel", + "default": 9 + }, + "allocationAndRetentionPriorityLevel": { + "description": "QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/ArpPriorityLevel", + "default": 9 + }, + "preemptionCapability": { + "description": "QoS Flow preemption capability. The Preemption Capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/PreemptionCapability", + "default": "NotPreempt" + }, + "preemptionVulnerability": { + "description": "QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/PreemptionVulnerability", + "default": "Preemptable" + }, + "maximumBitRate": { + "description": "The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service.", + "$ref": "./ts29571.json#/definitions/Ambr" + } + }, + "required": [ + "maximumBitRate" + ] + }, + "PccRuleQosPolicy": { + "description": "PCC rule QoS policy", + "type": "object", + "properties": { + "guaranteedBitRate": { + "description": "The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition.", + "$ref": "./ts29571.json#/definitions/Ambr" + } + }, + "allOf": [ + { + "$ref": "#/definitions/QosPolicy" + } + ] + }, + "TrafficControlPermission": { + "type": "string", + "description": "Traffic control permission.", + "enum": [ + "Enabled", + "Blocked" + ], + "x-ms-enum": { + "name": "TrafficControlPermission", + "modelAsString": true + } + }, + "SdfDirection": { + "type": "string", + "description": "Service data flow direction.", + "enum": [ + "Uplink", + "Downlink", + "Bidirectional" + ], + "x-ms-enum": { + "name": "SdfDirection", + "modelAsString": true + } + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/simPolicy.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/simPolicy.json new file mode 100644 index 000000000000..39e27be3807f --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/simPolicy.json @@ -0,0 +1,471 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage sim policy resources", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies/{simPolicyName}": { + "delete": { + "tags": [ + "SimPolicy" + ], + "operationId": "SimPolicies_Delete", + "description": "Deletes the specified sim policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete sim policy": { + "$ref": "./examples/SimPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SimPolicy" + ], + "operationId": "SimPolicies_Get", + "description": "Gets information about the specified sim policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting sim policy resource.", + "schema": { + "$ref": "#/definitions/SimPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get sim policy": { + "$ref": "./examples/SimPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "SimPolicy" + ], + "operationId": "SimPolicies_CreateOrUpdate", + "description": "Creates or updates a SimPolicy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SimPolicy" + }, + "description": "Parameters supplied to the create or update sim policy operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting sim policy resource.", + "schema": { + "$ref": "#/definitions/SimPolicy" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting sim policy resource.", + "schema": { + "$ref": "#/definitions/SimPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create sim policy": { + "$ref": "./examples/SimPolicyCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SimPolicy" + ], + "operationId": "SimPolicies_UpdateTags", + "description": "Update sim policy tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SimPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Sim Policy tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Sim Policy resource.", + "schema": { + "$ref": "#/definitions/SimPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update sim policy tags": { + "$ref": "./examples/SimPolicyUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/simPolicies": { + "get": { + "tags": [ + "SimPolicy" + ], + "operationId": "SimPolicies_ListByMobileNetwork", + "description": "Gets all the simPolicies in a mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of sim policy resources.", + "schema": { + "$ref": "#/definitions/SimPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List sim policies in a mobile network": { + "$ref": "./examples/SimPolicyListByMobileNetwork.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SimPolicy": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SimPolicyPropertiesFormat", + "description": "Sim policy Properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Sim policy resource." + }, + "SimPolicyPropertiesFormat": { + "description": "SimPolicy properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the sim policy resource.", + "$ref": "./common.json#/definitions/ProvisioningState" + }, + "ueAmbr": { + "description": "Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR.", + "$ref": "./ts29571.json#/definitions/Ambr" + }, + "defaultSlice": { + "description": "The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map.", + "$ref": "./common.json#/definitions/SliceResourceId" + }, + "rfspIndex": { + "description": "RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified.", + "$ref": "./ts29571.json#/definitions/RfspIndex" + }, + "registrationTimer": { + "description": "Interval for the UE periodic registration update procedure, in seconds.", + "type": "integer", + "format": "int32", + "minimum": 30, + "default": 3240 + }, + "sliceConfigurations": { + "description": "The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item.", + "type": "array", + "items": { + "$ref": "#/definitions/SliceConfiguration" + }, + "x-ms-identifiers": [], + "minItems": 1, + "uniqueItems": true + } + }, + "required": [ + "ueAmbr", + "defaultSlice", + "sliceConfigurations" + ] + }, + "SliceConfiguration": { + "description": "Per-slice settings", + "type": "object", + "properties": { + "slice": { + "description": "A reference to the Slice that these settings apply to", + "$ref": "./common.json#/definitions/SliceResourceId" + }, + "defaultDataNetwork": { + "description": "The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map.", + "$ref": "./common.json#/definitions/DataNetworkResourceId" + }, + "dataNetworkConfigurations": { + "description": "The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item.", + "type": "array", + "items": { + "$ref": "#/definitions/DataNetworkConfiguration" + }, + "x-ms-identifiers": [], + "minItems": 1, + "uniqueItems": true + } + }, + "required": [ + "slice", + "defaultDataNetwork", + "dataNetworkConfigurations" + ] + }, + "DataNetworkConfiguration": { + "description": "Settings controlling Data Network use", + "type": "object", + "properties": { + "dataNetwork": { + "description": "A reference to the Data Network that these settings apply to", + "$ref": "./common.json#/definitions/DataNetworkResourceId" + }, + "sessionAmbr": { + "description": "Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR.", + "$ref": "./ts29571.json#/definitions/Ambr" + }, + "5qi": { + "description": "Default QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This must not be a standardized 5QI value selecting a GBR (Guaranteed Bit Rate) QoS. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5Qi parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values.", + "$ref": "./ts29571.json#/definitions/5QiPriorityLevel", + "default": 9 + }, + "allocationAndRetentionPriorityLevel": { + "description": "Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/ArpPriorityLevel", + "default": 9 + }, + "preemptionCapability": { + "description": "Default QoS Flow preemption capability. The Preemption Capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/PreemptionCapability", + "default": "NotPreempt" + }, + "preemptionVulnerability": { + "description": "Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters.", + "$ref": "./ts29571.json#/definitions/PreemptionVulnerability", + "default": "Preemptable" + }, + "defaultSessionType": { + "description": "The default PDU session type, which is used if the UE does not request a specific session type.", + "$ref": "./ts29571.json#/definitions/PduSessionType", + "default": "IPv4" + }, + "additionalAllowedSessionTypes": { + "description": "Allowed session types in addition to the default session type. Must not duplicate the default session type.", + "type": "array", + "items": { + "$ref": "./ts29571.json#/definitions/PduSessionType" + }, + "maxItems": 1 + }, + "allowedServices": { + "description": "List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item.", + "type": "array", + "items": { + "$ref": "./common.json#/definitions/ServiceResourceId" + }, + "minItems": 1, + "uniqueItems": true + } + }, + "required": [ + "dataNetwork", + "sessionAmbr", + "allowedServices" + ] + }, + "SimPolicyListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SimPolicy" + }, + "description": "A list of SimPolicies." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for SimPolicies API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/slice.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/slice.json new file mode 100644 index 000000000000..95158ca53bbc --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/slice.json @@ -0,0 +1,359 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage network slice resources in mobile network", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices/{sliceName}": { + "delete": { + "tags": [ + "Slices" + ], + "operationId": "Slices_Delete", + "description": "Deletes the specified mobile network slice.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SliceNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete mobile network slice": { + "$ref": "./examples/SliceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Slices" + ], + "operationId": "Slices_Get", + "description": "Gets information about the specified mobile network slice.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SliceNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting mobile network slice resource.", + "schema": { + "$ref": "#/definitions/Slice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get mobile network slice": { + "$ref": "./examples/SliceGet.json" + } + } + }, + "put": { + "tags": [ + "Slices" + ], + "operationId": "Slices_CreateOrUpdate", + "description": "Creates or updates a mobile network slice.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SliceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Slice" + }, + "description": "Parameters supplied to the create or update mobile network slice operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network slice resource.", + "schema": { + "$ref": "#/definitions/Slice" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting mobile network slice resource.", + "schema": { + "$ref": "#/definitions/Slice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create mobile network slice": { + "$ref": "./examples/SliceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Slices" + ], + "operationId": "Slices_UpdateTags", + "description": "Update slice tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + }, + { + "$ref": "./common.json#/parameters/SliceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./common.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update mobile network slice tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting mobile network slice resource.", + "schema": { + "$ref": "#/definitions/Slice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update mobile network slice tags": { + "$ref": "./examples/SliceUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MobileNetwork/mobileNetworks/{mobileNetworkName}/slices": { + "get": { + "tags": [ + "Slices" + ], + "operationId": "Slices_ListByMobileNetwork", + "description": "Lists all slices in the mobile network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./common.json#/parameters/MobileNetworkNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of mobile network resources.", + "schema": { + "$ref": "#/definitions/SliceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List mobile network slices in a mobile network": { + "$ref": "./examples/SliceListByMobileNetwork.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Slice": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SlicePropertiesFormat", + "description": "Slice properties." + }, + "systemData": { + "x-ms-client-flatten": true, + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "description": "Network slice resource." + }, + "SlicePropertiesFormat": { + "description": "Network slice properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./common.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network slice resource." + }, + "snssai": { + "$ref": "./ts29571.json#/definitions/Snssai", + "description": "The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork." + }, + "description": { + "type": "string", + "description": "An optional description for this network slice." + } + }, + "required": [ + "snssai" + ] + }, + "SliceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Slice" + }, + "description": "A list of data networks in a resource group." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for attached data network API service call." + } + } +} diff --git a/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/ts29571.json b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/ts29571.json new file mode 100644 index 000000000000..1251078d8a1a --- /dev/null +++ b/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-01-01-preview/ts29571.json @@ -0,0 +1,297 @@ +{ + "swagger": "2.0", + "info": { + "title": "MobileNetworkManagementClient", + "description": "The resources in this swagger specification will be used to manage the virtual network functions deployed using mobile network. They are standard mobile network properties defined by 3GPP in TS 29.571 v16.6.0.", + "version": "2022-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "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": {}, + "definitions": { + "Ipv4Addr": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", + "description": "IPv4 address.", + "example": "198.51.100.1" + }, + "Ipv4AddrRm": { + "$ref": "#/definitions/Ipv4Addr", + "x-nullable": true, + "description": "IPv4 address or null." + }, + "Ipv4AddrMask": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))$", + "description": "IPv4 address mask.", + "example": "198.51.0.0/16" + }, + "Ipv4AddrMaskRm": { + "$ref": "#/definitions/Ipv4AddrMask", + "x-nullable": true, + "description": "IPv4 address mask or null." + }, + "BitRate": { + "type": "string", + "pattern": "^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$", + "description": "Bit rate." + }, + "BitRateRm": { + "$ref": "#/definitions/BitRate", + "x-nullable": true, + "description": "Bit rate or null." + }, + "Ambr": { + "description": "Aggregate Maximum Bit Rate.", + "type": "object", + "properties": { + "uplink": { + "$ref": "#/definitions/BitRate", + "description": "Uplink bit rate." + }, + "downlink": { + "$ref": "#/definitions/BitRate", + "description": "Downlink bit rate." + } + }, + "required": [ + "uplink", + "downlink" + ] + }, + "AmbrRm": { + "$ref": "#/definitions/Ambr", + "x-nullable": true, + "description": "Aggregate Maximum Bit Rate or null." + }, + "RfspIndex": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 256, + "description": "RAT/Frequency Selection Priority Index" + }, + "RfspIndexRm": { + "$ref": "#/definitions/RfspIndex", + "x-nullable": true, + "description": "RAT/Frequency Selection Priority Index or null" + }, + "5Qi": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 255, + "description": "5G QoS Identifier." + }, + "5QiRm": { + "$ref": "#/definitions/5Qi", + "x-nullable": true, + "description": "5G QoS Identifier or null." + }, + "5QiPriorityLevel": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 127, + "description": "5G QoS Identifier priority level." + }, + "5QiPriorityLevelRm": { + "$ref": "#/definitions/5QiPriorityLevel", + "x-nullable": true, + "description": "5G QoS Identifier priority level or null." + }, + "ArpPriorityLevel": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 15, + "description": "ARP priority level." + }, + "ArpPriorityLevelRm": { + "$ref": "#/definitions/ArpPriorityLevel", + "x-nullable": true, + "description": "ARP priority level or null." + }, + "PreemptionCapability": { + "type": "string", + "description": "Preemption capability.", + "enum": [ + "NotPreempt", + "MayPreempt" + ], + "x-ms-enum": { + "name": "PreemptionCapability", + "modelAsString": true + } + }, + "PreemptionVulnerability": { + "type": "string", + "description": "Preemption vulnerability.", + "enum": [ + "NotPreemptable", + "Preemptable" + ], + "x-ms-enum": { + "name": "PreemptionVulnerability", + "modelAsString": true + } + }, + "Arp": { + "description": "Allocation and Retention Priority (ARP) parameters.", + "type": "object", + "properties": { + "priorityLevel": { + "$ref": "#/definitions/ArpPriorityLevel", + "description": "ARP priority level." + }, + "preemptCap": { + "$ref": "#/definitions/PreemptionCapability", + "description": "ARP preemption capability." + }, + "preemptVuln": { + "$ref": "#/definitions/PreemptionVulnerability", + "description": "ARP preemption vulnerability" + } + }, + "required": [ + "priorityLevel", + "preemptCap", + "preemptVuln" + ] + }, + "Mcc": { + "type": "string", + "pattern": "^\\d{3}$", + "description": "Mobile Country Code." + }, + "MccRm": { + "$ref": "#/definitions/Mcc", + "x-nullable": true, + "description": "Mobile Country Code or null." + }, + "Mnc": { + "type": "string", + "pattern": "^\\d{2,3}$", + "description": "Mobile Network Code." + }, + "MncRm": { + "$ref": "#/definitions/Mnc", + "x-nullable": true, + "description": "Mobile Network Code or null." + }, + "PlmnId": { + "description": "Public Land Mobile Network (PLMN) ID.", + "type": "object", + "properties": { + "mcc": { + "$ref": "#/definitions/Mcc", + "description": "Mobile Country Code (MCC)." + }, + "mnc": { + "$ref": "#/definitions/Mnc", + "description": "Mobile Network Code (MNC)." + } + }, + "required": [ + "mcc", + "mnc" + ] + }, + "PlmnIdRm": { + "$ref": "#/definitions/PlmnId", + "x-nullable": true, + "description": "Public Land Mobile Network ID or null." + }, + "Tac": { + "type": "string", + "pattern": "(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)", + "description": "Tracking Area Code (TAC)." + }, + "TacRm": { + "$ref": "#/definitions/Tac", + "x-nullable": true, + "description": "Tracking Area Code (TAC) or null." + }, + "CoreNetworkType": { + "type": "string", + "description": "Core network type.", + "enum": [ + "5GC", + "EPC" + ], + "x-ms-enum": { + "name": "CoreNetworkType", + "modelAsString": true + } + }, + "CoreNetworkTypeRm": { + "$ref": "#/definitions/CoreNetworkType", + "x-nullable": true, + "description": "Core network type or null." + }, + "PduSessionType": { + "type": "string", + "description": "PDU session type (IPv4/IPv6).", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "PduSessionType", + "modelAsString": true + } + }, + "PduSessionTypeRm": { + "$ref": "#/definitions/PduSessionType", + "x-nullable": true, + "description": "PDU session type or null." + }, + "Snssai": { + "description": "Single-Network Slice Selection Assistance Information (S-NSSAI).", + "type": "object", + "properties": { + "sst": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 255, + "description": "Slice/Service Type (SST)." + }, + "sd": { + "type": "string", + "pattern": "^[A-Fa-f0-9]{6}$", + "description": "Slice Differentiator (SD)." + } + }, + "required": [ + "sst" + ] + } + } +} diff --git a/specification/mobilenetwork/resource-manager/readme.csharp.md b/specification/mobilenetwork/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..c170674c10d4 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.MobileNetwork + output-folder: $(csharp-sdks-folder)/mobilenetwork/management/Microsoft.MobileNetwork/GeneratedProtocol +``` diff --git a/specification/mobilenetwork/resource-manager/readme.go.md b/specification/mobilenetwork/resource-manager/readme.go.md new file mode 100644 index 000000000000..18de44ea839f --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/mobilenetwork/armmobilenetwork +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +``` diff --git a/specification/mobilenetwork/resource-manager/readme.md b/specification/mobilenetwork/resource-manager/readme.md new file mode 100644 index 000000000000..940d0c2a18b8 --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.md @@ -0,0 +1,90 @@ +# mobilenetwork + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for mobilenetwork. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the mobilenetwork. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2022-01-01-preview +``` + +### Tag: package-2022-01-01-preview + +These settings apply only when `--tag=package-2022-01-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2022-01-01-preview' +input-file: + - Microsoft.MobileNetwork/preview/2022-01-01-preview/attachedDataNetwork.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/common.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/dataNetwork.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/mobileNetwork.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/operation.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreControlPlane.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/packetCoreDataPlane.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/service.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/simPolicy.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/slice.json + - Microsoft.MobileNetwork/preview/2022-01-01-preview/ts29571.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go-track2 + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_mobilenetwork'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/mobilenetwork/resource-manager/readme.python.md b/specification/mobilenetwork/resource-manager/readme.python.md new file mode 100644 index 000000000000..8fe8ac8ef45d --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-mobilenetwork +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/mobilenetwork/azure-mgmt-mobilenetwork/azure/mgmt/mobilenetwork +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/mobilenetwork/azure-mgmt-mobilenetwork +``` diff --git a/specification/mobilenetwork/resource-manager/readme.ruby.md b/specification/mobilenetwork/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..1360aa8e013a --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_mobilenetwork +package-version: 2022-01-01-preview +azure-arm: true +``` + +### Tag: package-2022-01-01-preview and ruby + +These settings apply only when `--tag=package-2022-01-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2022-01-01-preview' && $(ruby) +namespace: Microsoft.MobileNetwork +output-folder: $(ruby-sdks-folder)/mobilenetwork +``` diff --git a/specification/mobilenetwork/resource-manager/readme.typescript.md b/specification/mobilenetwork/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..bb49da2bc7fb --- /dev/null +++ b/specification/mobilenetwork/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-mobilenetwork" + output-folder: "$(typescript-sdks-folder)/sdk/mobilenetwork/arm-mobilenetwork" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyEvents.json index 5899c79428ca..fc92a768c0d6 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyEvents.json @@ -814,6 +814,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json index 44cac58658a1..4530c0e39aa9 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json @@ -1543,6 +1543,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json index 728d607618f3..3edf6ba2f183 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json @@ -368,6 +368,10 @@ "enum": [ "default" ], + "x-ms-enum": { + "name": "PolicyTrackedResourcesResourceType", + "modelAsString": true + }, "description": "The name of the virtual resource under PolicyTrackedResources resource type; only \"default\" is allowed.", "x-ms-parameter-location": "method" }, @@ -379,6 +383,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json index 147393e8034d..8e53dabc6f59 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json @@ -1299,6 +1299,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json index 6f2779cb49b9..726a1d0be19f 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json @@ -774,6 +774,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json index 6a881ac0578a..5b5edb65af13 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json @@ -1390,6 +1390,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json index eade05405c40..392b08a5aeae 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json @@ -1325,6 +1325,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json index 4ab47f3b2a5d..39a104170cfb 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json @@ -912,6 +912,10 @@ "enum": [ "default" ], + "x-ms-enum": { + "name": "PolicyEventsResourceType", + "modelAsString": true + }, "description": "The name of the virtual resource under PolicyEvents resource type; only \"default\" is allowed.", "x-ms-parameter-location": "method" }, @@ -923,6 +927,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, @@ -967,6 +975,10 @@ "enum": [ "Microsoft.Authorization" ], + "x-ms-enum": { + "name": "AuthorizationNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json index d64a6edeabf9..14ac76131dc6 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json @@ -1759,6 +1759,10 @@ "enum": [ "latest" ], + "x-ms-enum": { + "name": "PolicyStatesSummaryResourceType", + "modelAsString": true + }, "description": "The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value.", "x-ms-parameter-location": "method" }, @@ -1770,6 +1774,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, @@ -1814,6 +1822,10 @@ "enum": [ "Microsoft.Authorization" ], + "x-ms-enum": { + "name": "AuthorizationNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json index 77edbba85dee..76d686cb1f81 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/remediations.json @@ -1362,6 +1362,10 @@ "enum": [ "Microsoft.Management" ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", "x-ms-parameter-location": "method" }, diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json index 8a57daafd48d..2b6fe4673861 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/examples/RedisCachePutPrivateEndpointConnection.json @@ -32,6 +32,7 @@ } } } - } + }, + "204": {} } } diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json index c99d21149c13..416633acc491 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-06-01/redis.json @@ -1660,6 +1660,9 @@ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" } }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCachePutPrivateEndpointConnection.json index c8d51c4c8e53..092d329a9262 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCachePutPrivateEndpointConnection.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/examples/RedisCachePutPrivateEndpointConnection.json @@ -32,6 +32,7 @@ } } } - } + }, + "204": {} } } diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json index 844bd69f8345..03005940c1f2 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2020-12-01/redis.json @@ -1663,6 +1663,9 @@ "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" } }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json index 48fca553443b..ce960dafa53c 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json @@ -966,6 +966,10 @@ "enum": [ "default" ], + "x-ms-enum": { + "name": "IssueName", + "modelAsString": false + }, "x-ms-parameter-location": "method" }, "ResourceGroupNameParameter": { diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2022-03-01-preview/changes.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2022-03-01-preview/changes.json index 50a9fb675edc..fd46e3196b77 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/preview/2022-03-01-preview/changes.json +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2022-03-01-preview/changes.json @@ -308,7 +308,8 @@ "readOnly": true, "enum": [ "User", - "System" + "System", + "Create" ], "x-ms-enum": { "name": "ChangeCategory", diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json index 49a2f615d2cd..b0a8ddd1c017 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json @@ -55,7 +55,7 @@ "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" } } }, @@ -113,7 +113,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -161,7 +161,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -230,7 +230,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -295,7 +295,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -350,7 +350,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -401,7 +401,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -470,7 +470,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -517,7 +517,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -566,7 +566,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -600,7 +600,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -639,7 +639,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -673,7 +673,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -723,7 +723,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -766,7 +766,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -814,7 +814,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -875,7 +875,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -931,7 +931,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -977,7 +977,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -1008,7 +1008,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -1049,7 +1049,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -1096,7 +1096,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -1154,7 +1154,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } } @@ -1210,7 +1210,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -1279,7 +1279,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -2062,24 +2062,6 @@ ], "description": "Managed application Jit access policy." }, - "ErrorResponse": { - "description": "Error response indicates managed application is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "httpStatus": { - "description": "Http status code.", - "type": "string" - }, - "errorCode": { - "description": "Error code.", - "type": "string" - }, - "errorMessage": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, "JitRequestDefinition": { "properties": { "properties": { @@ -2333,22 +2315,6 @@ } } }, - "OperationListResult": { - "description": "Result of the request to list Microsoft.Solutions operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Microsoft.Solutions operations." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, "DeploymentMode": { "description": "The deployment mode.", "enum": [ diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json index 285804f4a0bf..b1eaa14e65dd 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2021-10-01-preview/AlertRules.json @@ -705,35 +705,39 @@ "type": "array" }, "status": { - "description": "The alert rule template status.", - "enum": [ - "Installed", - "Available", - "NotAvailable" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TemplateStatus", - "values": [ - { - "description": "Alert rule template installed. and can not use more then once", - "value": "Installed" - }, - { - "description": "Alert rule template is available.", - "value": "Available" - }, - { - "description": "Alert rule template is not available", - "value": "NotAvailable" - } - ] - } + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status." } }, "type": "object" }, + "AlertRuleTemplateStatus": { + "description": "The alert rule template status.", + "enum": [ + "Installed", + "Available", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TemplateStatus", + "values": [ + { + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" + }, + { + "description": "Alert rule template is available.", + "value": "Available" + }, + { + "description": "Alert rule template is not available", + "value": "NotAvailable" + } + ] + } + }, "AlertRuleTemplateWithMitreProperties": { "allOf": [ { @@ -1164,26 +1168,8 @@ "description": "Represents Fusion alert rule template.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" - } - ], + "$ref": "#/definitions/FusionAlertRuleTemplateProperties", "description": "Fusion alert rule template properties", - "properties": { - "severity": { - "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", - "description": "The severity for alerts created by this alert rule." - }, - "sourceSettings": { - "description": "All supported source signal configurations consumed in fusion detection.", - "items": { - "$ref": "#/definitions/FusionTemplateSourceSetting" - }, - "x-ms-identifiers": [], - "type": "array" - } - }, "required": [ "displayName", "description", @@ -1192,13 +1178,36 @@ "sourceSettings", "alertRulesCreatedByTemplateCount" ], - "type": "object", "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "Fusion" }, + "FusionAlertRuleTemplateProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + } + ], + "description": "Fusion alert rule template properties", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "sourceSettings": { + "description": "All supported source signal configurations consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionTemplateSourceSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, "FusionTemplateSourceSetting": { "description": "Represents a source signal consumed in Fusion detection.", "properties": { @@ -1407,21 +1416,8 @@ "type": "array" }, "productFilter": { - "description": "The alerts' productName on which the cases will be generated", - "enum": [ - "Microsoft Cloud App Security", - "Azure Security Center", - "Azure Advanced Threat Protection", - "Azure Active Directory Identity Protection", - "Azure Security Center for IoT", - "Office 365 Advanced Threat Protection", - "Microsoft Defender Advanced Threat Protection" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "MicrosoftSecurityProductName" - } + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" }, "severitiesFilter": { "description": "the alerts' severities on which the cases will be generated", @@ -1436,6 +1432,23 @@ ], "type": "object" }, + "MicrosoftSecurityProductName": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT", + "Office 365 Advanced Threat Protection", + "Microsoft Defender Advanced Threat Protection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, "MicrosoftSecurityIncidentCreationAlertRuleProperties": { "allOf": [ { @@ -1483,14 +1496,7 @@ "description": "Represents MicrosoftSecurityIncidentCreation rule template.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - }, - { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" - } - ], + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", "description": "MicrosoftSecurityIncidentCreation rule template properties", "required": [ "displayName", @@ -1506,6 +1512,43 @@ "type": "object", "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, "QueryBasedAlertRuleProperties": { "description": "Query based alert rule base property bag.", "properties": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json index bba68aac2492..00f24cfb3ee0 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json @@ -60,6 +60,7 @@ "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", "properties": { "defaultAction": "Deny", + "publicNetworkAccess": "Enabled", "virtualNetworkRules": [ { "subnet": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json index 67ac3ac68b5a..6e6cb68947d7 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json @@ -12,7 +12,8 @@ "name": "default", "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", "properties": { - "defaultAction": "Deny", + "defaultAction": "Allow", + "publicNetworkAccess": "Enabled", "virtualNetworkRules": [ { "subnet": { diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json index 0afe99975fac..c509cbfa36dc 100644 --- a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json @@ -641,7 +641,10 @@ "type": "array", "items": { "$ref": "#/definitions/SourceConfiguration" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index ea30af1df007..5bfe733d7b6b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -2774,6 +2774,209 @@ "authenticationType" ] }, + "TeamDeskLinkedService": { + "x-ms-discriminator-value": "TeamDesk", + "description": "Linked service for TeamDesk.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "TeamDesk linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TeamDeskLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "TeamDeskLinkedServiceTypeProperties": { + "description": "TeamDesk linked service type properties.", + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "Token" + ], + "x-ms-enum": { + "name": "TeamDeskAuthenticationType", + "modelAsString": true + } + }, + "url": { + "type": "object", + "description": "The url to connect TeamDesk source. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "The username of the TeamDesk source. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password of the TeamDesk source.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The api token for the TeamDesk source." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "authenticationType", + "url" + ] + }, + "QuickbaseLinkedService": { + "x-ms-discriminator-value": "Quickbase", + "description": "Linked service for Quickbase.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Quickbase linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuickbaseLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "QuickbaseLinkedServiceTypeProperties": { + "description": "Quickbase linked service type properties.", + "type": "object", + "properties": { + "url": { + "type": "object", + "description": "The url to connect Quickbase source. Type: string (or Expression with resultType string)." + }, + "userToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The user token for the Quickbase source." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url", + "userToken" + ] + }, + "SmartsheetLinkedService": { + "x-ms-discriminator-value": "Smartsheet", + "description": "Linked service for Smartsheet.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Smartsheet linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SmartsheetLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SmartsheetLinkedServiceTypeProperties": { + "description": "Smartsheet linked service type properties.", + "type": "object", + "properties": { + "apiToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The api token for the Smartsheet source." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "apiToken" + ] + }, + "ZendeskLinkedService": { + "x-ms-discriminator-value": "Zendesk", + "description": "Linked service for Zendesk.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Zendesk linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ZendeskLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ZendeskLinkedServiceTypeProperties": { + "description": "Zendesk linked service type properties.", + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type to use.", + "type": "string", + "enum": [ + "Basic", + "Token" + ], + "x-ms-enum": { + "name": "ZendeskAuthenticationType", + "modelAsString": true + } + }, + "url": { + "type": "object", + "description": "The url to connect Zendesk source. Type: string (or Expression with resultType string)." + }, + "userName": { + "type": "object", + "description": "The username of the Zendesk source. Type: string (or Expression with resultType string)." + }, + "password": { + "description": "The password of the Zendesk source.", + "$ref": "../artifacts.json#/definitions/SecretBase" + }, + "apiToken": { + "$ref": "../artifacts.json#/definitions/SecretBase", + "description": "The api token for the Zendesk source." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "authenticationType", + "url" + ] + }, "AmazonS3LinkedService": { "x-ms-discriminator-value": "AmazonS3", "description": "Linked service for Amazon S3.", diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/Domains.json index 41985def9575..c65d3d6b35f1 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/Domains.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/Domains.json @@ -988,7 +988,10 @@ "items": { "$ref": "#/definitions/HostName" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] }, "consent": { "$ref": "#/definitions/DomainPurchaseConsent", @@ -1303,7 +1306,10 @@ "items": { "$ref": "#/definitions/HostName" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] }, "consent": { "$ref": "#/definitions/DomainPurchaseConsent", @@ -1471,7 +1477,10 @@ "type": "array", "items": { "$ref": "../../../Microsoft.Web/stable/2021-03-01/CommonDefinitions.json#/definitions/NameIdentifier" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "Link to next page of resources.", diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/TopLevelDomains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/TopLevelDomains.json index 823501dd4c8c..86260718c074 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/TopLevelDomains.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2021-03-01/TopLevelDomains.json @@ -196,7 +196,10 @@ "type": "array", "items": { "$ref": "#/definitions/TldLegalAgreement" - } + }, + "x-ms-identifiers": [ + "agreementKey" + ] }, "nextLink": { "description": "Link to next page of resources.", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/AppServiceEnvironments.json index ff24faac2d46..f36d5cf03314 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/AppServiceEnvironments.json @@ -2178,7 +2178,10 @@ "type": "array", "items": { "$ref": "#/definitions/VirtualIPMapping" - } + }, + "x-ms-identifiers": [ + "virtualIP" + ] } }, "x-ms-client-flatten": true @@ -2303,7 +2306,11 @@ "type": "array", "items": { "$ref": "#/definitions/EndpointDetail" - } + }, + "x-ms-identifiers": [ + "ipAddress", + "port" + ] } } }, @@ -2381,7 +2388,8 @@ "type": "array", "items": { "$ref": "#/definitions/InboundEnvironmentEndpoint" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "Link to next page of resources.", @@ -2403,7 +2411,10 @@ "type": "array", "items": { "$ref": "#/definitions/EndpointDependency" - } + }, + "x-ms-identifiers": [ + "domainName" + ] } } }, @@ -2419,7 +2430,10 @@ "type": "array", "items": { "$ref": "#/definitions/OutboundEnvironmentEndpoint" - } + }, + "x-ms-identifiers": [ + "category" + ] }, "nextLink": { "description": "Link to next page of resources.", @@ -2473,7 +2487,8 @@ "items": { "$ref": "#/definitions/ResourceMetricAvailability" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "resourceUri": { "description": "Resource URI.", @@ -2544,7 +2559,11 @@ "type": "array", "items": { "$ref": "#/definitions/SkuInfo" - } + }, + "x-ms-identifiers": [ + "/sku/name", + "resourceType" + ] }, "nextLink": { "description": "Link to next page of resources.", @@ -2645,7 +2664,10 @@ "type": "array", "items": { "$ref": "#/definitions/StampCapacity" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "Link to next page of resources.", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/CommonDefinitions.json index 7b42713406bb..244b5439f9fa 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/CommonDefinitions.json @@ -132,7 +132,10 @@ "type": "array", "items": { "$ref": "#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "userWhitelistedIpRanges": { "description": "User added ip ranges to whitelist on ASE db", @@ -428,7 +431,10 @@ "type": "array", "items": { "$ref": "#/definitions/StatusCodesBasedTrigger" - } + }, + "x-ms-identifiers": [ + "path" + ] }, "slowRequests": { "$ref": "#/definitions/SlowRequestsBasedTrigger", @@ -439,14 +445,20 @@ "type": "array", "items": { "$ref": "#/definitions/SlowRequestsBasedTrigger" - } + }, + "x-ms-identifiers": [ + "path" + ] }, "statusCodesRange": { "description": "A rule based on status codes ranges.", "type": "array", "items": { "$ref": "#/definitions/StatusCodesRangeBasedTrigger" - } + }, + "x-ms-identifiers": [ + "path" + ] } } }, @@ -642,7 +654,10 @@ "type": "array", "items": { "$ref": "#/definitions/EnvironmentVar" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "resources": { "$ref": "#/definitions/ContainerResources", @@ -694,7 +709,10 @@ "type": "array", "items": { "$ref": "#/definitions/CsmOperationDescription" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "Link to next page of resources.", @@ -792,7 +810,10 @@ "type": "array", "items": { "$ref": "#/definitions/CsmUsageQuota" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "nextLink": { "description": "Link to next page of resources.", @@ -821,7 +842,10 @@ "type": "array", "items": { "$ref": "#/definitions/ScaleRuleAuth" - } + }, + "x-ms-identifiers": [ + "triggerParameter" + ] } } }, @@ -847,7 +871,10 @@ "type": "array", "items": { "$ref": "#/definitions/DaprComponent" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -872,7 +899,10 @@ "type": "array", "items": { "$ref": "#/definitions/DaprMetadata" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -907,7 +937,10 @@ "items": { "$ref": "#/definitions/KeyValuePair[String,Object]" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "key" + ] } } }, @@ -942,7 +975,10 @@ "type": "array", "items": { "$ref": "#/definitions/DataTableResponseColumn" - } + }, + "x-ms-identifiers": [ + "columnName" + ] }, "rows": { "description": "Raw row values", @@ -1002,7 +1038,8 @@ } }, "readOnly": true - } + }, + "x-ms-identifiers": [] }, "innererror": { "description": "More information to debug error.", @@ -1162,7 +1199,8 @@ "type": "array", "items": { "$ref": "#/definitions/DiagnosticData" - } + }, + "x-ms-identifiers": [] }, "status": { "$ref": "#/definitions/Status", @@ -1173,7 +1211,10 @@ "type": "array", "items": { "$ref": "#/definitions/DataProviderMetadata" - } + }, + "x-ms-identifiers": [ + "providerName" + ] }, "suggestedUtterances": { "$ref": "#/definitions/QueryUtterancesResults", @@ -1279,14 +1320,16 @@ "type": "array", "items": { "$ref": "#/definitions/ErrorEntity" - } + }, + "x-ms-identifiers": [] }, "details": { "description": "Error Details.", "type": "array", "items": { "$ref": "#/definitions/ErrorEntity" - } + }, + "x-ms-identifiers": [] }, "target": { "description": "The error target.", @@ -1311,7 +1354,10 @@ "type": "array", "items": { "$ref": "#/definitions/RampUpRule" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -1572,7 +1618,10 @@ "type": "array", "items": { "$ref": "#/definitions/ScaleRuleAuth" - } + }, + "x-ms-identifiers": [ + "triggerParameter" + ] } } }, @@ -1905,7 +1954,10 @@ "type": "array", "items": { "$ref": "#/definitions/Dimension" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "category": { "type": "string" @@ -1914,7 +1966,8 @@ "type": "array", "items": { "$ref": "#/definitions/MetricAvailability" - } + }, + "x-ms-identifiers": [] }, "supportedTimeGrainTypes": { "type": "array", @@ -1986,7 +2039,8 @@ "type": "array", "items": { "$ref": "#/definitions/ErrorEntity" - } + }, + "x-ms-identifiers": [] }, "createdTime": { "format": "date-time", @@ -2234,7 +2288,8 @@ "type": "array", "items": { "$ref": "#/definitions/QueryUtterancesResult" - } + }, + "x-ms-identifiers": [] } } }, @@ -2256,7 +2311,10 @@ "type": "array", "items": { "$ref": "#/definitions/ScaleRuleAuth" - } + }, + "x-ms-identifiers": [ + "triggerParameter" + ] } } }, @@ -2483,7 +2541,10 @@ "type": "array", "items": { "$ref": "#/definitions/ScaleRule" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -2531,13 +2592,19 @@ "type": "array", "items": { "$ref": "#/definitions/MetricSpecification" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "logSpecifications": { "type": "array", "items": { "$ref": "#/definitions/LogSpecification" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -2616,7 +2683,10 @@ "type": "array", "items": { "$ref": "#/definitions/HostNameSslState" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "serverFarmId": { "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", @@ -2918,14 +2988,20 @@ "type": "array", "items": { "$ref": "#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "connectionStrings": { "description": "Connection strings.", "type": "array", "items": { "$ref": "#/definitions/ConnStringInfo" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "machineKey": { "$ref": "#/definitions/SiteMachineKey", @@ -2937,7 +3013,10 @@ "type": "array", "items": { "$ref": "#/definitions/HandlerMapping" - } + }, + "x-ms-identifiers": [ + "extension" + ] }, "documentRoot": { "description": "Document root.", @@ -3012,7 +3091,10 @@ "type": "array", "items": { "$ref": "#/definitions/VirtualApplication" - } + }, + "x-ms-identifiers": [ + "virtualPath" + ] }, "loadBalancing": { "description": "Site load balancing.", @@ -3111,14 +3193,20 @@ "type": "array", "items": { "$ref": "#/definitions/IpSecurityRestriction" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "scmIpSecurityRestrictions": { "description": "IP security restrictions for scm.", "type": "array", "items": { "$ref": "#/definitions/IpSecurityRestriction" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "scmIpSecurityRestrictionsUseMain": { "description": "IP security restrictions for scm to use main.", @@ -3327,7 +3415,10 @@ "type": "array", "items": { "$ref": "#/definitions/Capability" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -3528,7 +3619,10 @@ "type": "array", "items": { "$ref": "#/definitions/Container" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "scale": { "$ref": "#/definitions/Scale", @@ -3605,7 +3699,10 @@ "type": "array", "items": { "$ref": "#/definitions/VirtualDirectory" - } + }, + "x-ms-identifiers": [ + "virtualPath" + ] } } }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ContainerApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ContainerApps.json index afb9ba61ef4a..aeb895a90a39 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ContainerApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ContainerApps.json @@ -309,7 +309,10 @@ "type": "array", "items": { "$ref": "#/definitions/Secret" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "activeRevisionsMode": { "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\nMultiple: multiple revisions can be active. If no value if provided, this is the defaultSingle: Only one revision can be active at a time. Revision weights can not be used in this mode", @@ -332,7 +335,10 @@ "type": "array", "items": { "$ref": "#/definitions/RegistryCredentials" - } + }, + "x-ms-identifiers": [ + "server" + ] } } }, @@ -428,7 +434,10 @@ "type": "array", "items": { "$ref": "#/definitions/ContainerAppSecret" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -468,7 +477,10 @@ "type": "array", "items": { "$ref": "#/definitions/TrafficWeight" - } + }, + "x-ms-identifiers": [ + "revisionName" + ] }, "allowInsecure": { "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Diagnostics.json index 3c328d205c73..4f89876bfa36 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Diagnostics.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Diagnostics.json @@ -1549,7 +1549,8 @@ "type": "array", "items": { "$ref": "#/definitions/DetectorAbnormalTimePeriod" - } + }, + "x-ms-identifiers": [] }, "solutions": { "description": "List of proposed solutions", @@ -1577,7 +1578,10 @@ "type": "array", "items": { "$ref": "#/definitions/DiagnosticMetricSet" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "data": { "description": "Additional Source Data", @@ -1586,7 +1590,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "detectorMetaData": { @@ -1634,7 +1641,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -1672,7 +1682,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "type": { @@ -1774,21 +1787,28 @@ "type": "array", "items": { "$ref": "#/definitions/AbnormalTimePeriod" - } + }, + "x-ms-identifiers": [] }, "payload": { "description": "Data by each detector", "type": "array", "items": { "$ref": "#/definitions/AnalysisData" - } + }, + "x-ms-identifiers": [ + "source" + ] }, "nonCorrelatedDetectors": { "description": "Data by each detector for detectors that did not corelate", "type": "array", "items": { "$ref": "#/definitions/DetectorDefinition" - } + }, + "x-ms-identifiers": [ + "displayName" + ] } }, "x-ms-client-flatten": true @@ -1917,14 +1937,18 @@ "type": "array", "items": { "$ref": "#/definitions/DiagnosticMetricSet" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "abnormalTimePeriods": { "description": "List of Correlated events found by the detector", "type": "array", "items": { "$ref": "#/definitions/DetectorAbnormalTimePeriod" - } + }, + "x-ms-identifiers": [] }, "data": { "description": "Additional Data that detector wants to send.", @@ -1933,7 +1957,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "responseMetaData": { @@ -2010,7 +2037,8 @@ "type": "array", "items": { "$ref": "#/definitions/DiagnosticMetricSample" - } + }, + "x-ms-identifiers": [] } } }, @@ -2065,7 +2093,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "metadata": { @@ -2075,7 +2106,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/NameValuePair" - } + }, + "x-ms-identifiers": [ + "name" + ] } } } diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Provider.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Provider.json index 21a14817cbab..f3bcd5fe5da5 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Provider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/Provider.json @@ -388,21 +388,30 @@ "type": "array", "items": { "$ref": "#/definitions/StackMajorVersion" - } + }, + "x-ms-identifiers": [ + "runtimeVersion" + ] }, "frameworks": { "description": "List of frameworks associated with application stack.", "type": "array", "items": { "$ref": "#/definitions/ApplicationStack" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "isDeprecated": { "description": "true if this is the stack is deprecated; otherwise, false.", "type": "array", "items": { "$ref": "#/definitions/ApplicationStack" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -464,7 +473,10 @@ "items": { "$ref": "#/definitions/FunctionAppMinorVersion" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] } } }, @@ -622,7 +634,10 @@ "items": { "$ref": "#/definitions/FunctionAppMajorVersion" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] }, "preferredOs": { "description": "Function App stack preferred OS.", @@ -773,7 +788,10 @@ "type": "array", "items": { "$ref": "#/definitions/StackMinorVersion" - } + }, + "x-ms-identifiers": [ + "runtimeVersion" + ] }, "applicationInsights": { "description": "true if this supports Application Insights; otherwise, false.", @@ -849,7 +867,10 @@ "items": { "$ref": "#/definitions/WebAppMinorVersion" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] } } }, @@ -991,7 +1012,10 @@ "items": { "$ref": "#/definitions/WebAppMajorVersion" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "value" + ] }, "preferredOs": { "description": "Web App stack preferred OS.", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ResourceProvider.json index a2df7a1fed31..bc833fc86f44 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ResourceProvider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/ResourceProvider.json @@ -860,14 +860,18 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment" - } + }, + "x-ms-identifiers": [] }, "hostingEnvironmentDeploymentInfos": { "description": "Available App Service Environments with basic information.", "type": "array", "items": { "$ref": "#/definitions/HostingEnvironmentDeploymentInfo" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -961,7 +965,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/Capability" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -1146,7 +1153,10 @@ "type": "array", "items": { "$ref": "#/definitions/GlobalCsmSkuDescription" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json index bc1867636f03..8c38e3f664a1 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2021-03-01/WebApps.json @@ -21788,7 +21788,10 @@ "items": { "$ref": "#/definitions/DatabaseBackupSetting" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] }, "scheduled": { "description": "True if this backup has been created due to a schedule being triggered.", @@ -21881,7 +21884,10 @@ "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" - } + }, + "x-ms-identifiers": [ + "name" + ] } }, "x-ms-client-flatten": true @@ -23364,7 +23370,10 @@ "type": "array", "items": { "$ref": "#/definitions/MSDeployCore" - } + }, + "x-ms-identifiers": [ + "packageUri" + ] } }, "x-ms-client-flatten": true @@ -23427,7 +23436,8 @@ "items": { "$ref": "#/definitions/MSDeployLogEntry" }, - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] } }, "x-ms-client-flatten": true @@ -23773,7 +23783,8 @@ "type": "array", "items": { "$ref": "#/definitions/PerfMonResponse" - } + }, + "x-ms-identifiers": [] }, "nextLink": { "description": "Link to next page of resources.", @@ -23847,7 +23858,8 @@ "type": "array", "items": { "$ref": "#/definitions/PerfMonSample" - } + }, + "x-ms-identifiers": [] } } }, @@ -23949,7 +23961,10 @@ "type": "array", "items": { "$ref": "#/definitions/PrivateAccessVirtualNetwork" - } + }, + "x-ms-identifiers": [ + "key" + ] } }, "x-ms-client-flatten": true @@ -23993,7 +24008,10 @@ "type": "array", "items": { "$ref": "#/definitions/PrivateAccessSubnet" - } + }, + "x-ms-identifiers": [ + "key" + ] } } }, @@ -24549,7 +24567,10 @@ "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "ignoreConflictingHostNames": { "description": "Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation.", @@ -24866,21 +24887,30 @@ "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "unsupportedFeatures": { "description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.", "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "blockingCharacteristics": { "description": "List of blocking application characteristics.", "type": "array", "items": { "$ref": "#/definitions/SiteCloneabilityCriterion" - } + }, + "x-ms-identifiers": [ + "name" + ] } } }, @@ -25228,7 +25258,10 @@ "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/HostNameSslState" - } + }, + "x-ms-identifiers": [ + "name" + ] }, "serverFarmId": { "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".", @@ -25879,7 +25912,10 @@ "type": "array", "items": { "$ref": "#/definitions/TriggeredJobRun" - } + }, + "x-ms-identifiers": [ + "web_job_id" + ] } }, "x-ms-client-flatten": true