From 9d0fd3313c3ac997f467ecafe9179266b63e13c9 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar <32332608+gauravkumar1491@users.noreply.github.com>
Date: Thu, 23 Mar 2023 16:26:46 -0700
Subject: [PATCH 01/37] Adds base for updating Microsoft.Resources from version
stable/2021-01-01 to version 2022-12-01
---
.../examples/CalculateTemplateHash.json | 46 +
.../examples/CheckResourceName.json | 20 +
.../examples/CreateResourceGroup.json | 32 +
.../examples/ExportResourceGroup.json | 68 +
.../ExportResourceGroupWithFiltering.json | 46 +
.../ForceDeleteVMsAndVMSSInResourceGroup.json | 16 +
.../ForceDeleteVMsInResourceGroup.json | 16 +
.../2022-12-01/examples/GetLocations.json | 54 +
.../GetLocationsWithExtendedLocations.json | 83 +
.../examples/GetNamedProviderAtTenant.json | 253 +
.../2022-12-01/examples/GetProvider.json | 51 +
.../examples/GetProviderResourceTypes.json | 47 +
.../2022-12-01/examples/GetProviders.json | 175 +
.../2022-12-01/examples/GetSubscription.json | 32 +
.../2022-12-01/examples/GetSubscriptions.json | 61 +
.../2022-12-01/examples/GetTagsResource.json | 18 +
.../examples/GetTagsSubscription.json | 18 +
.../2022-12-01/examples/GetTenants.json | 53 +
.../examples/PostCheckZonePeers.json | 49 +
...PostDeploymentWhatIfOnManagementGroup.json | 87 +
.../PostDeploymentWhatIfOnResourceGroup.json | 73 +
.../PostDeploymentWhatIfOnSubscription.json | 84 +
.../PostDeploymentWhatIfOnTenant.json | 40 +
.../PutDeploymentAtManagementGroup.json | 139 +
.../examples/PutDeploymentAtScope.json | 151 +
.../examples/PutDeploymentAtTenant.json | 150 +
.../examples/PutDeploymentResourceGroup.json | 93 +
...ymentResourceGroupTemplateSpecsWithId.json | 92 +
...oymentSubscriptionTemplateSpecsWithId.json | 66 +
...ntWithOnErrorDeploymentLastSuccessful.json | 168 +
...thOnErrorDeploymentSpecificDeployment.json | 169 +
.../2022-12-01/examples/PutTagsResource.json | 26 +
.../examples/PutTagsSubscription.json | 26 +
.../stable/2022-12-01/resources.json | 6446 +++++++++++++++++
.../stable/2022-12-01/subscriptions.json | 847 +++
35 files changed, 9795 insertions(+)
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
new file mode 100644
index 000000000000..d1f83634bd30
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2021-01-01",
+ "template": {
+ "$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "string": {
+ "type": "string"
+ }
+ },
+ "variables": {
+ "string": "string",
+ "int": 42,
+ "bool": true,
+ "array": [
+ 1,
+ 2,
+ 3,
+ 4
+ ],
+ "object": {
+ "object": {
+ "vmSize": "Large",
+ "location": "West US"
+ }
+ }
+ },
+ "resources": [],
+ "outputs": {
+ "string": {
+ "type": "string",
+ "value": "myvalue"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "minifiedTemplate": "{\"$SCHEMA\":\"HTTP://SCHEMAS.MANAGEMENT.AZURE.COM/DEPLOYMENTTEMPLATE?API-VERSION=2014-04-01-PREVIEW\",\"CONTENTVERSION\":\"1.0.0.0\",\"PARAMETERS\":{\"STRING\":{\"TYPE\":\"STRING\"}},\"VARIABLES\":{\"STRING\":\"STRING\",\"INT\":42,\"BOOL\":TRUE,\"ARRAY\":[1,2,3,4],\"OBJECT\":{\"OBJECT\":{\"VMSIZE\":\"LARGE\",\"LOCATION\":\"WEST US\"}}},\"RESOURCES\":[],\"OUTPUTS\":{\"STRING\":{\"TYPE\":\"STRING\",\"VALUE\":\"MYVALUE\"}}}",
+ "templateHash": "695440707931307747"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
new file mode 100644
index 000000000000..45b60e3b9971
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "body": [
+ {
+ "Name": "isxbox",
+ "Type": "ResourceProviderTestHost/TestResourceType"
+ }
+ ],
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "isxbox",
+ "type": "ResourceProviderTestHost/TestResourceType",
+ "status": "Allowed"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
new file mode 100644
index 000000000000..74398d45af47
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus"
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
+ "name": "my-resource-group",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
+ "name": "my-resource-group",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
new file mode 100644
index 000000000000..5c3a43383fd1
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "resources": [
+ "*"
+ ],
+ "options": "IncludeParameterDefaultValue,IncludeComments"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
+ }
+ },
+ "200": {
+ "body": {
+ "template": {
+ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "myResourceType_myFirstResource_name": {
+ "defaultValue": "myFirstResource",
+ "type": "String"
+ },
+ "myResourceType_mySecondResource_name": {
+ "defaultValue": "mySecondResource",
+ "type": "String"
+ },
+ "myResourceType_myFirstResource_secret": {
+ "defaultValue": null,
+ "type": "SecureString"
+ }
+ },
+ "variables": {},
+ "resources": [
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "[parameters('myResourceType_myFirstResource_name')]",
+ "location": "West US",
+ "properties": {
+ "secret": "[parameters('myResourceType_myFirstResource_secret')]"
+ }
+ },
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "[parameters('myResourceType_mySecondResource_name')]",
+ "location": "West US",
+ "properties": {
+ "customProperty": "hello!"
+ }
+ }
+ ]
+ },
+ "error": {
+ "code": "ExportTemplateCompletedWithErrors",
+ "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.",
+ "details": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
new file mode 100644
index 000000000000..b70a6c3b1c65
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "resources": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
+ ],
+ "options": "SkipResourceNameParameterization"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
+ }
+ },
+ "200": {
+ "body": {
+ "template": {
+ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "myResourceType_myFirstResource_secret": {
+ "defaultValue": null,
+ "type": "SecureString"
+ }
+ },
+ "variables": {},
+ "resources": [
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "myFirstResource",
+ "location": "West US",
+ "properties": {
+ "secret": "[parameters('myResourceType_myFirstResource_secret')]"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
new file mode 100644
index 000000000000..2dba850f1157
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "forceDeletionTypes": "Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "200": {
+ "description": "OK"
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
new file mode 100644
index 000000000000..ba2a47410f91
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "forceDeletionTypes": "Microsoft.Compute/virtualMachines",
+ "api-version": "2020-06-01"
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "200": {
+ "description": "OK"
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
new file mode 100644
index 000000000000..445f660c0b38
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/westus"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/centralus"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
new file mode 100644
index 000000000000..ded38f8b6a21
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
@@ -0,0 +1,83 @@
+{
+ "parameters": {
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "api-version": "2021-01-01",
+ "includeExtendedLocations": "true"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/westus"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/centralus"
+ }
+ ]
+ }
+ },
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/westus/edgeZones/microsoftlosangeles1",
+ "name": "microsoftlosangeles1",
+ "type": "EdgeZone",
+ "displayName": "Microsoft Los Angeles 1",
+ "regionalDisplayName": "Microsoft Los Angeles 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "longitude": "-118.235374",
+ "latitude": "34.058414",
+ "homeLocation": "westus"
+ }
+ },
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus2euap/edgeZones/microsoftrrdclab1",
+ "name": "microsoftrrdclab1",
+ "type": "EdgeZone",
+ "displayName": "Microsoft RRDC Lab 1",
+ "regionalDisplayName": "Microsoft RRDC Lab 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "longitude": "-122.03197",
+ "latitude": "47.69106",
+ "homeLocation": "eastus2euap"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
new file mode 100644
index 000000000000..86573a1566d2
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
@@ -0,0 +1,253 @@
+{
+ "parameters": {
+ "$expand": "resourceTypes/aliases",
+ "resourceProviderNamespace": "Microsoft.Storage",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "East US",
+ "East US 2",
+ "East US 2 (Stage)",
+ "West US",
+ "West Europe",
+ "East Asia",
+ "Southeast Asia",
+ "Japan East",
+ "Japan West",
+ "North Central US",
+ "South Central US",
+ "Central US",
+ "North Europe",
+ "Brazil South",
+ "Australia East",
+ "Australia Southeast",
+ "South India",
+ "Central India",
+ "West India",
+ "Canada East",
+ "Canada Central",
+ "West US 2",
+ "West Central US",
+ "UK South",
+ "UK West",
+ "Korea Central",
+ "Korea South",
+ "East US 2 EUAP",
+ "Central US EUAP",
+ "France Central",
+ "France South",
+ "Australia Central",
+ "Australia Central 2",
+ "South Africa West",
+ "South Africa North",
+ "UAE Central",
+ "UAE North",
+ "Switzerland North",
+ "Switzerland West",
+ "Germany West Central",
+ "Germany North",
+ "Norway East",
+ "Norway West",
+ "South Central US STG",
+ "Brazil Southeast"
+ ],
+ "apiVersions": [
+ "2019-06-01",
+ "2019-04-01",
+ "2018-11-01",
+ "2018-07-01",
+ "2018-03-01-preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ],
+ "defaultApiVersion": "2019-06-01",
+ "apiProfiles": [
+ {
+ "profileVersion": "2019-03-01-hybrid",
+ "apiVersion": "2017-10-01"
+ },
+ {
+ "profileVersion": "2017-03-09-profile",
+ "apiVersion": "2016-01-01"
+ },
+ {
+ "profileVersion": "2018-03-01-hybrid",
+ "apiVersion": "2016-01-01"
+ },
+ {
+ "profileVersion": "2018-06-01-profile",
+ "apiVersion": "2017-10-01"
+ }
+ ],
+ "aliases": [
+ {
+ "name": "Microsoft.Storage/storageAccounts/accountType",
+ "paths": [
+ {
+ "path": "properties.accountType",
+ "apiVersions": [
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ },
+ {
+ "path": "sku.name",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01"
+ ]
+ }
+ ],
+ "defaultPath": "sku.name"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/sku.name",
+ "paths": [
+ {
+ "path": "properties.accountType",
+ "apiVersions": [
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ },
+ {
+ "path": "sku.name",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01"
+ ]
+ }
+ ],
+ "defaultPath": "sku.name"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/accessTier",
+ "paths": [
+ {
+ "path": "properties.accessTier",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.accessTier"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/enableBlobEncryption",
+ "paths": [
+ {
+ "path": "properties.encryption.services.blob.enabled",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.encryption.services.blob.enabled"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/enableFileEncryption",
+ "paths": [
+ {
+ "path": "properties.encryption.services.file.enabled",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.encryption.services.file.enabled"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/supportsHttpsTrafficOnly",
+ "paths": [
+ {
+ "path": "properties.supportsHttpsTrafficOnly",
+ "apiVersions": [
+ "2018-11-09",
+ "2018-03-01-Preview",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ],
+ "metadata": {
+ "type": "NotSpecified",
+ "attributes": "None"
+ }
+ }
+ ],
+ "defaultPath": "properties.supportsHttpsTrafficOnly",
+ "defaultMetadata": {
+ "type": "Boolean",
+ "attributes": "Modifiable"
+ }
+ }
+ ],
+ "capabilities": "SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
new file mode 100644
index 000000000000..c56e92960fbc
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceProviderNamespace": "Microsoft.TestRP1",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
+ "namespace": "Microsoft.TestRP1",
+ "registrationState": "Registering",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
new file mode 100644
index 000000000000..bbb9260ba33a
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceProviderNamespace": "Microsoft.TestRP",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
new file mode 100644
index 000000000000..20756d3a8b52
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
@@ -0,0 +1,175 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
+ "namespace": "Microsoft.TestRP1",
+ "registrationState": "Registering",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources",
+ "namespace": "Microsoft.Resources",
+ "registrationState": "Registered",
+ "registrationPolicy": "RegistrationFree",
+ "resourceTypes": [
+ {
+ "resourceType": "subscriptions",
+ "locations": [
+ "eastus",
+ "eastus2",
+ "westus"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "resourceGroups",
+ "locations": [
+ "centralus",
+ "eastasia",
+ "southeastasia"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "subscriptions/resourceGroups",
+ "locations": [
+ "eastus",
+ "eastus2",
+ "westus"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "bulkDelete",
+ "locations": [
+ "centralus",
+ "eastasia"
+ ],
+ "apiVersions": [
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "deployments",
+ "locations": [],
+ "apiVersions": [
+ "2017-08-01",
+ "2017-06-01"
+ ],
+ "aliases": [],
+ "capabilities": "SupportsTags"
+ },
+ {
+ "resourceType": "tags",
+ "locations": [
+ "DevFabric"
+ ],
+ "apiVersions": [],
+ "aliases": [],
+ "capabilities": "SupportsExtension"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP2",
+ "namespace": "Microsoft.TestRP2",
+ "registrationState": "NotRegistered",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
new file mode 100644
index 000000000000..f62a28551dcc
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
+ "displayName": "Example Subscription",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "Bypassed",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
new file mode 100644
index 000000000000..b340788d7eee
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
+ "displayName": "Example Subscription",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "RoleBased",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ },
+ {
+ "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
+ "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
+ "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c",
+ "displayName": "Example Subscription2",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "RoleBased",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ },
+ {
+ "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ }
+ ],
+ "nextLink": "..."
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
new file mode 100644
index 000000000000..b66f222eb0af
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
new file mode 100644
index 000000000000..625262aec894
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
new file mode 100644
index 000000000000..553693bbc1e4
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
+ "tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
+ "countryCode": "US",
+ "displayName": "Test_Test_aad50",
+ "domains": [
+ "aad50.ccsctp.net"
+ ],
+ "tenantCategory": "ManagedBy",
+ "defaultDomain": "aad50.ccsctp.net",
+ "tenantType": "AAD"
+ },
+ {
+ "id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "countryCode": "US",
+ "displayName": "Contoso Corp.",
+ "domains": [
+ "auxteststagemanual.ccsctp.net"
+ ],
+ "tenantCategory": "Home",
+ "defaultDomain": "auxteststagemanual.ccsctp.net",
+ "tenantType": "AAD"
+ },
+ {
+ "id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
+ "tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
+ "countryCode": "US",
+ "displayName": "TEST_TEST_RDV",
+ "domains": [
+ "rdvmohoro.ccsctp.net",
+ "rdvmohoro.mail.ccsctp.net",
+ "rdvmohoro.com"
+ ],
+ "tenantCategory": "ProjectedBy",
+ "defaultDomain": "rdvmohoro.ccsctp.net",
+ "tenantType": "AAD",
+ "tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com"
+ }
+ ],
+ "nextLink": "..."
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
new file mode 100644
index 000000000000..fd52e3c1b2e6
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "subscriptionIds": [
+ "subscriptions/11111111-1111-1111-1111-111111111111"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "location": "eastus2",
+ "availabilityZonePeers": [
+ {
+ "availabilityZone": "1",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "3"
+ }
+ ]
+ },
+ {
+ "availabilityZone": "2",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "2"
+ }
+ ]
+ },
+ {
+ "availabilityZone": "3",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "1"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
new file mode 100644
index 000000000000..3439446e7254
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "groupId": "myManagementGruop",
+ "deploymentName": "exampleDeploymentName",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
+ "enforcementMode": "Default"
+ }
+ },
+ "after": {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
+ "enforcementMode": "DoNotEnforce"
+ }
+ },
+ "delta": [
+ {
+ "path": "properties.enforcementMode",
+ "propertyChangeType": "Modify",
+ "before": "Default",
+ "after": "DoNotEnforce"
+ }
+ ]
+ }
+ },
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment2",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
+ "enforcementMode": "Default"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
new file mode 100644
index 000000000000..f8d370feeb6a
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
@@ -0,0 +1,73 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2"
+ },
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2",
+ "tags": {
+ "myNewTag": "my tag value"
+ }
+ },
+ "delta": [
+ {
+ "path": "tags.myNewTag",
+ "propertyChangeType": "Create",
+ "after": "my tag value"
+ }
+ ]
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myNewIdentity",
+ "location": "eastus",
+ "tags": {
+ "myOtherNewTag": "another new tag value"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
new file mode 100644
index 000000000000..1178815a7bfd
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2"
+ },
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2",
+ "tags": {
+ "myNewTag": "my tag value"
+ }
+ },
+ "delta": [
+ {
+ "path": "tags.myNewTag",
+ "propertyChangeType": "Create",
+ "after": "my tag value"
+ }
+ ]
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myNewIdentity",
+ "location": "eastus",
+ "tags": {
+ "myOtherNewTag": "another new tag value"
+ }
+ }
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2019-03-01",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
+ "type": "Microsoft.Resources/resourceGroups",
+ "name": "my-resource-group2",
+ "location": "{location3}"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
new file mode 100644
index 000000000000..0fcab3e885a1
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "deploymentName": "exampleDeploymentName",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
+ "changeType": "Create",
+ "after": {
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
+ "apiVersion": "2019-11-01",
+ "type": "Microsoft.Management/managementGroups",
+ "name": "myManagementGroup"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
new file mode 100644
index 000000000000..4e3566988164
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
@@ -0,0 +1,139 @@
+{
+ "parameters": {
+ "groupId": "my-management-group-id",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
new file mode 100644
index 000000000000..3c0c649f4c06
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
@@ -0,0 +1,151 @@
+{
+ "parameters": {
+ "scope": "providers/Microsoft.Management/managementGroups/my-management-group-id",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
new file mode 100644
index 000000000000..e610b895cb91
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
@@ -0,0 +1,150 @@
+{
+ "parameters": {
+ "deploymentName": "tenant-dep01",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
+ "name": "tenant-dep01",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
+ "name": "tenant-dep01",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
new file mode 100644
index 000000000000..00357457df8b
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [],
+ "outputResources": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
new file mode 100644
index 000000000000..e92197398583
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [],
+ "outputResources": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
new file mode 100644
index 000000000000..176551e6c9b2
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:51:58.6288067Z",
+ "duration": "PT1.2637681S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [],
+ "dependencies": [],
+ "outputResources": []
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:51:58.6288067Z",
+ "duration": "PT1.2637681S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
new file mode 100644
index 000000000000..9ff4e6e5c909
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
@@ -0,0 +1,168 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "onErrorDeployment": {
+ "type": "LastSuccessful"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "LastSuccessful",
+ "deploymentName": "{nameOfLastSuccesfulDeployment}"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "LastSuccessful",
+ "deploymentName": "{nameOfLastSuccesfulDeployment}"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
new file mode 100644
index 000000000000..1d735cd878fd
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
@@ -0,0 +1,169 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
new file mode 100644
index 000000000000..39b2f5583b88
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
new file mode 100644
index 000000000000..d193c0a7e661
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
new file mode 100644
index 000000000000..2b1e32082928
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
@@ -0,0 +1,6446 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ResourceManagementClient",
+ "version": "2021-01-01",
+ "description": "Provides operations for working with resources and resource groups."
+ },
+ "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.Resources/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Lists all of the available Microsoft.Resources REST API operations.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtScope",
+ "summary": "Deploys resources at a given scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at a given scope.": {
+ "$ref": "./examples/PutDeploymentAtScope.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtScope",
+ "description": "Get all the deployments at the given scope.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtTenantScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtTenantScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtTenantScope",
+ "summary": "Deploys resources at tenant scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at tenant scope.": {
+ "$ref": "./examples/PutDeploymentAtTenant.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtTenantScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtTenantScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtTenantScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtTenantScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at management group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnTenant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtTenantScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtTenantScope",
+ "description": "Get all the deployments at the tenant scope.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtManagementGroupScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtManagementGroupScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtManagementGroupScope",
+ "summary": "Deploys resources at management group scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at management group scope.": {
+ "$ref": "./examples/PutDeploymentAtManagementGroup.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtManagementGroupScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtManagementGroupScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtManagementGroupScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtManagementGroupScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at management group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtManagementGroupScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtManagementGroupScope",
+ "description": "Get all the deployments for a management group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtSubscriptionScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtSubscriptionScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope",
+ "summary": "Deploys resources at subscription scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a deployment that will deploy a templateSpec with the given resourceId": {
+ "$ref": "./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtSubscriptionScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtSubscriptionScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtSubscriptionScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtSubscriptionScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeploymentWhatIf"
+ },
+ "description": "Parameters to What If."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at subscription scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnSubscription.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtSubscriptionScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtSubscriptionScope",
+ "description": "Get all the deployments for a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Delete",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployment to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistence",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployment to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdate",
+ "summary": "Deploys resources to a resource group.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a deployment that will redeploy the last successful deployment on failure": {
+ "$ref": "./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json"
+ },
+ "Create a deployment that will redeploy another deployment on failure": {
+ "$ref": "./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json"
+ },
+ "Create a deployment that will deploy a templateSpec with the given resourceId": {
+ "$ref": "./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json"
+ },
+ "Create a deployment that will deploy a template with a uri and queryString": {
+ "$ref": "./examples/PutDeploymentResourceGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Get",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Cancel",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Validate",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIf",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at resource group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnResourceGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplate",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListByResourceGroup",
+ "description": "Get all the deployments for a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployments to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Unregister",
+ "description": "Unregisters a subscription from a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to unregister."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_RegisterAtManagementGroupScope",
+ "description": "Registers a management group with a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to register."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Register",
+ "description": "Registers a subscription with a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to register."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_List",
+ "description": "Gets all resource providers for a subscription.",
+ "parameters": [
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed returns all deployments."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource providers.",
+ "schema": {
+ "$ref": "#/definitions/ProviderListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get providers.": {
+ "$ref": "./examples/GetProviders.json"
+ }
+ }
+ }
+ },
+ "/providers": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_ListAtTenantScope",
+ "description": "Gets all resource providers for the tenant.",
+ "parameters": [
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed returns all providers."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource providers.",
+ "schema": {
+ "$ref": "#/definitions/ProviderListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Get",
+ "description": "Gets the specified resource provider.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get provider.": {
+ "$ref": "./examples/GetProvider.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "ProviderResourceTypes_List",
+ "description": "List the resource types for a specified resource provider.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns resource types information for the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/ProviderResourceTypeListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get provider resource types.": {
+ "$ref": "./examples/GetProviderResourceTypes.json"
+ }
+ }
+ }
+ },
+ "/providers/{resourceProviderNamespace}": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "x-ms-examples": {
+ "Get a resource provider at tenant scope": {
+ "$ref": "./examples/GetNamedProviderAtTenant.json"
+ }
+ },
+ "operationId": "Providers_GetAtTenantScope",
+ "description": "Gets the specified resource provider at the tenant level.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": {
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "Resources_ListByResourceGroup",
+ "description": "Get all the resources for a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource group with the resources to get.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": {
+ "head": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_CheckExistence",
+ "description": "Checks whether a resource group exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "x-ms-examples": {
+ "Create or update a resource group": {
+ "$ref": "./examples/CreateResourceGroup.json"
+ }
+ },
+ "operationId": "ResourceGroups_CreateOrUpdate",
+ "description": "Creates or updates a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "Parameters supplied to the create or update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Delete",
+ "summary": "Deletes a resource group.",
+ "description": "When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "forceDeletionTypes",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "x-ms-examples": {
+ "Force delete all the Virtual Machines in a resource group": {
+ "$ref": "./examples/ForceDeleteVMsInResourceGroup.json"
+ },
+ "Force delete all the Virtual Machines and Virtual Machine Scale Sets in a resource group": {
+ "$ref": "./examples/ForceDeleteVMsAndVMSSInResourceGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Get",
+ "description": "Gets a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Update",
+ "summary": "Updates a resource group.",
+ "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to update. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupPatchable"
+ },
+ "description": "Parameters supplied to update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_ExportTemplate",
+ "description": "Captures the specified resource group as a template.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportTemplateRequest"
+ },
+ "description": "Parameters for exporting the template."
+ }
+ ],
+ "x-ms-examples": {
+ "Export a resource group": {
+ "$ref": "./examples/ExportResourceGroup.json"
+ },
+ "Export a resource group with filtering": {
+ "$ref": "./examples/ExportResourceGroupWithFiltering.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the result of the export.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupExportResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "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"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups": {
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_List",
+ "description": "Gets all the resource groups for a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resource groups."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource groups.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/ResourceGroupFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_MoveResources",
+ "summary": "Moves resources from one resource group to another resource group.",
+ "description": "The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_ValidateMoveResources",
+ "summary": "Validates whether resources can be moved from one resource group to another resource group.",
+ "description": "This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to validate for move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resources": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_List",
+ "description": "Get all the resources in a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources.",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistence",
+ "description": "Checks whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource provider of the resource to check."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to check whether it exists."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Delete",
+ "description": "Deletes a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group that contains the resource to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to delete."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdate",
+ "description": "Creates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to create.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to create."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for creating or updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Update",
+ "description": "Updates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to update.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to update."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Get",
+ "description": "Gets a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to get."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{resourceId}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistenceById",
+ "description": "Checks by ID whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_DeleteById",
+ "description": "Deletes a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdateById",
+ "description": "Create a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Create or update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_UpdateById",
+ "description": "Updates a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_GetById",
+ "description": "Gets a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": {
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_DeleteValue",
+ "summary": "Deletes a predefined tag value for a predefined tag name.",
+ "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to delete."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag value did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdateValue",
+ "summary": "Creates a predefined value for a predefined tag name.",
+ "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value already exists. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "201": {
+ "description": "Predefined tag value successfully created. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdate",
+ "summary": "Creates a predefined tag name.",
+ "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name already exists. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "201": {
+ "description": "Predefined tag name successfully created. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_Delete",
+ "summary": "Deletes a predefined tag name.",
+ "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag name did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames": {
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_List",
+ "summary": "Gets a summary of tag usage under the subscription.",
+ "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of tag names and values.",
+ "schema": {
+ "$ref": "#/definitions/TagsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtTenantScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtTenantScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtManagementGroupScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtManagementGroupScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtSubscriptionScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtSubscriptionScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_Get",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_List",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/calculateTemplateHash": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CalculateTemplateHash",
+ "description": "Calculate the hash of the given template.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "template",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object"
+ },
+ "description": "The template provided to calculate hash."
+ }
+ ],
+ "x-ms-examples": {
+ "Calculate template hash": {
+ "$ref": "./examples/CalculateTemplateHash.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the hash.",
+ "schema": {
+ "$ref": "#/definitions/TemplateHashResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/tags/default": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdateAtScope",
+ "summary": "Creates or updates the entire set of tags on a resource or subscription.",
+ "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update tags on a resource": {
+ "$ref": "./examples/PutTagsResource.json"
+ },
+ "Update tags on a subscription": {
+ "$ref": "./examples/PutTagsSubscription.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_UpdateAtScope",
+ "summary": "Selectively updates the set of tags on a resource or subscription.",
+ "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsPatchResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_GetAtScope",
+ "summary": "Gets the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get tags on a resource": {
+ "$ref": "./examples/GetTagsResource.json"
+ },
+ "Get tags on a subscription": {
+ "$ref": "./examples/GetTagsSubscription.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_DeleteAtScope",
+ "summary": "Deletes the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags successfully deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DeploymentExtendedFilter": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "description": "The provisioning state."
+ }
+ },
+ "description": "Deployment filter."
+ },
+ "GenericResourceFilter": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "tagname": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagvalue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource filter."
+ },
+ "ResourceGroupFilter": {
+ "properties": {
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource group filter."
+ },
+ "TemplateLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the template to deploy. Use either the uri or id property, but not both."
+ },
+ "id": {
+ "type": "string",
+ "description": "The resource id of a Template Spec. Use either the id or uri property, but not both."
+ },
+ "relativePath": {
+ "type": "string",
+ "description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs"
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ },
+ "queryString": {
+ "type": "string",
+ "description": "The query string (for example, a SAS token) to be used with the templateLink URI."
+ }
+ },
+ "description": "Entity representing the reference to the template."
+ },
+ "ParametersLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the parameters file."
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "description": "Entity representing the reference to the deployment parameters."
+ },
+ "DeploymentProperties": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both."
+ },
+ "templateLink": {
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI of the template. Use either the templateLink property or the template property, but not both."
+ },
+ "parameters": {
+ "type": "object",
+ "description": "Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string."
+ },
+ "parametersLink": {
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both."
+ },
+ "mode": {
+ "type": "string",
+ "description": "The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "$ref": "#/definitions/OnErrorDeployment",
+ "description": "The deployment on error behavior."
+ },
+ "expressionEvaluationOptions": {
+ "$ref": "#/definitions/ExpressionEvaluationOptions",
+ "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer."
+ }
+ },
+ "required": [
+ "mode"
+ ],
+ "description": "Deployment properties."
+ },
+ "DebugSetting": {
+ "properties": {
+ "detailLevel": {
+ "type": "string",
+ "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations."
+ }
+ },
+ "description": "The debug setting."
+ },
+ "Deployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "ScopedDeployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "DeploymentExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ }
+ },
+ "description": "The deployment export result. "
+ },
+ "DeploymentWhatIf": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentWhatIfProperties",
+ "description": "The deployment properties."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment What-if operation parameters."
+ },
+ "ScopedDeploymentWhatIf": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentWhatIfProperties",
+ "description": "The deployment properties."
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "description": "Deployment What-if operation parameters."
+ },
+ "DeploymentWhatIfProperties": {
+ "properties": {
+ "whatIfSettings": {
+ "$ref": "#/definitions/DeploymentWhatIfSettings",
+ "description": "Optional What-If operation settings."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeploymentProperties"
+ }
+ ],
+ "description": "Deployment What-if properties."
+ },
+ "DeploymentWhatIfSettings": {
+ "properties": {
+ "resultFormat": {
+ "type": "string",
+ "description": "The format of the What-If results",
+ "enum": [
+ "ResourceIdOnly",
+ "FullResourcePayloads"
+ ],
+ "x-ms-enum": {
+ "name": "WhatIfResultFormat",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Deployment What-If operation settings."
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "An error response for a resource management request."
+ },
+ "ApiProfile": {
+ "properties": {
+ "profileVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The profile version."
+ },
+ "apiVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The API version."
+ }
+ }
+ },
+ "AliasPathMetadata": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "NotSpecified",
+ "Any",
+ "String",
+ "Object",
+ "Array",
+ "Integer",
+ "Number",
+ "Boolean"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPathTokenType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "The token type is not specified."
+ },
+ {
+ "value": "Any",
+ "description": "The token type can be anything."
+ },
+ {
+ "value": "String",
+ "description": "The token type is string."
+ },
+ {
+ "value": "Object",
+ "description": "The token type is object."
+ },
+ {
+ "value": "Array",
+ "description": "The token type is array."
+ },
+ {
+ "value": "Integer",
+ "description": "The token type is integer."
+ },
+ {
+ "value": "Number",
+ "description": "The token type is number."
+ },
+ {
+ "value": "Boolean",
+ "description": "The token type is boolean."
+ }
+ ]
+ },
+ "description": "The type of the token that the alias path is referring to."
+ },
+ "attributes": {
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "None",
+ "Modifiable"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPathAttributes",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "The token that the alias path is referring to has no attributes."
+ },
+ {
+ "value": "Modifiable",
+ "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
+ }
+ ]
+ },
+ "description": "The attributes of the token that the alias path is referring to."
+ }
+ }
+ },
+ "AliasPath": {
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of an alias."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API versions."
+ },
+ "pattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The pattern for an alias path."
+ },
+ "metadata": {
+ "readOnly": true,
+ "$ref": "#/definitions/AliasPathMetadata",
+ "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias."
+ }
+ },
+ "description": "The type of the paths for alias."
+ },
+ "AliasPattern": {
+ "properties": {
+ "phrase": {
+ "type": "string",
+ "description": "The alias pattern phrase."
+ },
+ "variable": {
+ "type": "string",
+ "description": "The alias pattern variable."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Extract"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPatternType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "NotSpecified is not allowed."
+ },
+ {
+ "value": "Extract",
+ "description": "Extract is the only allowed value."
+ }
+ ]
+ },
+ "description": "The type of alias pattern"
+ }
+ },
+ "description": "The type of the pattern for an alias path."
+ },
+ "Alias": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The alias name."
+ },
+ "paths": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AliasPath"
+ },
+ "description": "The paths for an alias."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the alias.",
+ "enum": [
+ "NotSpecified",
+ "PlainText",
+ "Mask"
+ ],
+ "x-ms-enum": {
+ "name": "AliasType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "Alias type is unknown (same as not providing alias type)."
+ },
+ {
+ "value": "PlainText",
+ "description": "Alias value is not secret."
+ },
+ {
+ "value": "Mask",
+ "description": "Alias value is secret."
+ }
+ ]
+ }
+ },
+ "defaultPath": {
+ "type": "string",
+ "description": "The default path for an alias."
+ },
+ "defaultPattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The default pattern for an alias."
+ },
+ "defaultMetadata": {
+ "readOnly": true,
+ "$ref": "#/definitions/AliasPathMetadata",
+ "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata"
+ }
+ },
+ "description": "The alias type. "
+ },
+ "ProviderExtendedLocation": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The azure location."
+ },
+ "type": {
+ "type": "string",
+ "description": "The extended location type."
+ },
+ "extendedLocations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The extended locations for the azure location."
+ }
+ },
+ "description": "The provider extended location. "
+ },
+ "ProviderResourceType": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "locations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The collection of locations where this resource type can be created."
+ },
+ "locationMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderExtendedLocation"
+ },
+ "description": "The location mappings that are supported by this resource type."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Alias"
+ },
+ "description": "The aliases that are supported by this resource type."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API version."
+ },
+ "defaultApiVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The default API version."
+ },
+ "zoneMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ZoneMapping"
+ }
+ },
+ "apiProfiles": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ApiProfile"
+ },
+ "description": "The API profiles for the resource provider."
+ },
+ "capabilities": {
+ "type": "string",
+ "description": "The additional capabilities offered by this resource type."
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The properties."
+ }
+ },
+ "description": "Resource type managed by the resource provider."
+ },
+ "Provider": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provider ID."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ "registrationState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration state of the resource provider."
+ },
+ "registrationPolicy": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration policy of the resource provider."
+ },
+ "resourceTypes": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderResourceType"
+ },
+ "description": "The collection of provider resource types."
+ }
+ },
+ "description": "Resource provider information."
+ },
+ "BasicDependency": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "Dependency": {
+ "properties": {
+ "dependsOn": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BasicDependency"
+ },
+ "description": "The list of dependencies."
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "DeploymentPropertiesExtended": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Denotes the state of provisioning.",
+ "enum": [
+ "NotSpecified",
+ "Accepted",
+ "Running",
+ "Ready",
+ "Creating",
+ "Created",
+ "Deleting",
+ "Deleted",
+ "Canceled",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "correlationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The correlation ID of the deployment."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of the template deployment."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the template deployment."
+ },
+ "outputs": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Key/value pairs that represent deployment output."
+ },
+ "providers": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "The list of resource providers needed for the deployment."
+ },
+ "dependencies": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Dependency"
+ },
+ "description": "The list of deployment dependencies."
+ },
+ "templateLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI referencing the template."
+ },
+ "parameters": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Deployment parameters. "
+ },
+ "parametersLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI referencing the parameters. "
+ },
+ "mode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The deployment mode. Possible values are Incremental and Complete.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "readOnly": true,
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "readOnly": true,
+ "$ref": "#/definitions/OnErrorDeploymentExtended",
+ "description": "The deployment on error behavior."
+ },
+ "templateHash": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The hash produced for the template."
+ },
+ "outputResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of provisioned resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of provisioned resources."
+ }
+ },
+ "validatedResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of validated resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of validated resources."
+ }
+ },
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment error."
+ }
+ },
+ "description": "Deployment properties with additional details."
+ },
+ "ResourceReference": {
+ "description": "The resource Id model.",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified resource Id."
+ }
+ }
+ },
+ "OnErrorDeployment": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior."
+ },
+ "OnErrorDeploymentExtended": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning for the on error deployment."
+ },
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior with additional details."
+ },
+ "DeploymentValidateResult": {
+ "properties": {
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment validation error."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "The template deployment properties."
+ }
+ },
+ "description": "Information from validate template deployment response."
+ },
+ "DeploymentExtended": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the deployment."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the deployment."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the deployment."
+ },
+ "location": {
+ "type": "string",
+ "description": "the location of the deployment."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "Deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Deployment information."
+ },
+ "DeploymentListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentExtended"
+ },
+ "description": "An array of deployments."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployments."
+ },
+ "ProviderListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "An array of resource providers."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource providers."
+ },
+ "ProviderResourceTypeListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderResourceType"
+ },
+ "description": "An array of resource types."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource types of a resource provider."
+ },
+ "GenericResource": {
+ "properties": {
+ "plan": {
+ "$ref": "#/definitions/Plan",
+ "description": "The plan of the resource."
+ },
+ "properties": {
+ "type": "object",
+ "description": "The resource properties."
+ },
+ "kind": {
+ "type": "string",
+ "description": "The kind of the resource.",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "ID of the resource that manages this resource."
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the resource."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "ExtendedLocation": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "ExtendedLocationType",
+ "modelAsString": true
+ },
+ "description": "The extended location type."
+ },
+ "name": {
+ "type": "string",
+ "description": "The extended location name."
+ }
+ },
+ "description": "Resource extended location."
+ },
+ "GenericResourceExpanded": {
+ "properties": {
+ "createdTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The created time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "changedTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/GenericResource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "Plan": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The plan ID."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The publisher ID."
+ },
+ "product": {
+ "type": "string",
+ "description": "The offer ID."
+ },
+ "promotionCode": {
+ "type": "string",
+ "description": "The promotion code."
+ },
+ "version": {
+ "type": "string",
+ "description": "The plan's version."
+ }
+ },
+ "description": "Plan for the resource."
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The SKU name."
+ },
+ "tier": {
+ "type": "string",
+ "description": "The SKU tier."
+ },
+ "size": {
+ "type": "string",
+ "description": "The SKU size."
+ },
+ "family": {
+ "type": "string",
+ "description": "The SKU family."
+ },
+ "model": {
+ "type": "string",
+ "description": "The SKU model."
+ },
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The SKU capacity."
+ }
+ },
+ "description": "SKU for the resource."
+ },
+ "Identity": {
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal ID of resource identity."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID of resource."
+ },
+ "type": {
+ "type": "string",
+ "description": "The identity type.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "x-ms-client-name": "IdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the resource."
+ },
+ "ResourceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GenericResourceExpanded"
+ },
+ "description": "An array of resources."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourceGroup": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the resource group."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "x-ms-azure-resource": true,
+ "description": "Resource group information."
+ },
+ "ResourceGroupPatchable": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "description": "Resource group information."
+ },
+ "ResourceGroupProperties": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state. "
+ }
+ },
+ "description": "The resource group properties."
+ },
+ "ResourceGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "An array of resource groups."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourcesMoveInfo": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources."
+ },
+ "targetResourceGroup": {
+ "type": "string",
+ "description": "The target resource group."
+ }
+ },
+ "description": "Parameters of move resources."
+ },
+ "ExportTemplateRequest": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'."
+ },
+ "options": {
+ "type": "string",
+ "description": "The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'"
+ }
+ },
+ "description": "Export resource group template request parameters."
+ },
+ "TagCount": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of count."
+ },
+ "value": {
+ "type": "integer",
+ "description": "Value of count."
+ }
+ },
+ "description": "Tag count."
+ },
+ "TagValue": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag value ID."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The tag value count."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag information."
+ },
+ "TagDetails": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag name ID."
+ },
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagValue"
+ },
+ "description": "The list of tag values."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag details."
+ },
+ "TagsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagDetails"
+ },
+ "description": "An array of tags."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of subscription tags."
+ },
+ "TargetResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the resource."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The type of the resource."
+ }
+ },
+ "description": "Target resource."
+ },
+ "HttpMessage": {
+ "properties": {
+ "content": {
+ "type": "object",
+ "description": "HTTP message content."
+ }
+ },
+ "description": "HTTP message."
+ },
+ "DeploymentOperationProperties": {
+ "properties": {
+ "provisioningOperation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the current provisioning operation.",
+ "enum": [
+ "NotSpecified",
+ "Create",
+ "Delete",
+ "Waiting",
+ "AzureAsyncOperationWaiting",
+ "ResourceCacheWaiting",
+ "Action",
+ "Read",
+ "EvaluateDeploymentOutput",
+ "DeploymentCleanup"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningOperation",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "The provisioning operation is not specified."
+ },
+ {
+ "value": "Create",
+ "description": "The provisioning operation is create."
+ },
+ {
+ "value": "Delete",
+ "description": "The provisioning operation is delete."
+ },
+ {
+ "value": "Waiting",
+ "description": "The provisioning operation is waiting."
+ },
+ {
+ "value": "AzureAsyncOperationWaiting",
+ "description": "The provisioning operation is waiting Azure async operation."
+ },
+ {
+ "value": "ResourceCacheWaiting",
+ "description": "The provisioning operation is waiting for resource cache."
+ },
+ {
+ "value": "Action",
+ "description": "The provisioning operation is action."
+ },
+ {
+ "value": "Read",
+ "description": "The provisioning operation is read."
+ },
+ {
+ "value": "EvaluateDeploymentOutput",
+ "description": "The provisioning operation is evaluate output."
+ },
+ {
+ "value": "DeploymentCleanup",
+ "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment."
+ }
+ ]
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of the operation."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the operation."
+ },
+ "serviceRequestId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation service request id."
+ },
+ "statusCode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation status code from the resource provider. This property may not be set if a response has not yet been received."
+ },
+ "statusMessage": {
+ "readOnly": true,
+ "description": "Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider.",
+ "$ref": "#/definitions/StatusMessage"
+ },
+ "targetResource": {
+ "readOnly": true,
+ "$ref": "#/definitions/TargetResource",
+ "description": "The target resource."
+ },
+ "request": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP request message."
+ },
+ "response": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP response message."
+ }
+ },
+ "description": "Deployment operation properties."
+ },
+ "DeploymentOperation": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Full deployment operation ID."
+ },
+ "operationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation ID."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentOperationProperties",
+ "description": "Deployment properties."
+ }
+ },
+ "description": "Deployment operation information."
+ },
+ "DeploymentOperationsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentOperation"
+ },
+ "description": "An array of deployment operations."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployment operations."
+ },
+ "ResourceProviderOperationDisplayProperties": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "description": "Operation description."
+ },
+ "provider": {
+ "type": "string",
+ "description": "Operation provider."
+ },
+ "resource": {
+ "type": "string",
+ "description": "Operation resource."
+ },
+ "operation": {
+ "type": "string",
+ "description": "Resource provider operation."
+ },
+ "description": {
+ "type": "string",
+ "description": "Operation description."
+ }
+ },
+ "description": "Resource provider operation's display properties."
+ },
+ "Resource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "Resource extended location."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Specified resource."
+ },
+ "SubResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource ID"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Sub-resource."
+ },
+ "ResourceGroupExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The template export error."
+ }
+ },
+ "description": "Resource group export result."
+ },
+ "Operation": {
+ "description": "Microsoft.Resources operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Microsoft.Resources 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.Resources operations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "TemplateHashResult": {
+ "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.",
+ "properties": {
+ "minifiedTemplate": {
+ "type": "string",
+ "description": "The minified template string."
+ },
+ "templateHash": {
+ "type": "string",
+ "description": "The template hash."
+ }
+ }
+ },
+ "WhatIfPropertyChange": {
+ "required": [
+ "path",
+ "propertyChangeType"
+ ],
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the property."
+ },
+ "propertyChangeType": {
+ "type": "string",
+ "description": "The type of property change.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Modify",
+ "Array",
+ "NoEffect"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Modify",
+ "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed."
+ },
+ {
+ "value": "Array",
+ "description": "The property is an array and contains nested changes."
+ },
+ {
+ "value": "NoEffect",
+ "description": "The property will not be set or updated."
+ }
+ ]
+ }
+ },
+ "before": {
+ "type": "object",
+ "description": "The value of the property before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The value of the property after the deployment is executed."
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "Nested property changes."
+ }
+ },
+ "description": "The predicted change to the resource property."
+ },
+ "WhatIfChange": {
+ "description": "Information about a single resource change predicted by What-If operation.",
+ "required": [
+ "resourceId",
+ "changeType"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "changeType": {
+ "type": "string",
+ "description": "Type of change that will be made to the resource when the deployment is executed.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Ignore",
+ "Deploy",
+ "NoChange",
+ "Modify",
+ "Unsupported"
+ ],
+ "x-ms-enum": {
+ "name": "ChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Ignore",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed."
+ },
+ {
+ "value": "Deploy",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change."
+ },
+ {
+ "value": "NoChange",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change."
+ },
+ {
+ "value": "Modify",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change."
+ },
+ {
+ "value": "Unsupported",
+ "description": "The resource is not supported by What-If."
+ }
+ ]
+ }
+ },
+ "unsupportedReason": {
+ "type": "string",
+ "description": "The explanation about why the resource is unsupported by What-If."
+ },
+ "before": {
+ "type": "object",
+ "description": "The snapshot of the resource before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The predicted snapshot of the resource after the deployment is executed."
+ },
+ "delta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "The predicted changes to resource properties."
+ }
+ }
+ },
+ "WhatIfOperationProperties": {
+ "description": "Deployment operation properties.",
+ "properties": {
+ "changes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfChange"
+ },
+ "description": "List of resource changes predicted by What-If operation."
+ }
+ }
+ },
+ "WhatIfOperationResult": {
+ "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the What-If operation."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WhatIfOperationProperties",
+ "description": "What-If operation properties."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "Error when What-If operation fails."
+ }
+ }
+ },
+ "Tags": {
+ "description": "A dictionary of name and value pairs.",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ }
+ }
+ },
+ "TagsPatchResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags patch API request only.",
+ "properties": {
+ "operation": {
+ "type": "string",
+ "description": "The operation type for the patch API.",
+ "enum": [
+ "Replace",
+ "Merge",
+ "Delete"
+ ],
+ "x-ms-enum": {
+ "name": "tagsPatchOperation",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Replace",
+ "description": "The 'replace' option replaces the entire set of existing tags with a new set."
+ },
+ {
+ "value": "Merge",
+ "description": "The 'merge' option allows adding tags with new names and updating the values of tags with existing names."
+ },
+ {
+ "value": "Delete",
+ "description": "The 'delete' option allows selectively deleting tags based on given names or name/value pairs."
+ }
+ ]
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ }
+ },
+ "TagsResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags API requests and responses.",
+ "required": [
+ "properties"
+ ],
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the tags wrapper resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the tags wrapper resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the tags wrapper resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "StatusMessage": {
+ "type": "object",
+ "description": "Operation status message object.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the deployment operation."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The error reported by the operation."
+ }
+ }
+ },
+ "ExpressionEvaluationOptions": {
+ "properties": {
+ "scope": {
+ "type": "string",
+ "description": "The scope to be used for evaluation of parameters, variables and functions in a nested template.",
+ "enum": [
+ "NotSpecified",
+ "Outer",
+ "Inner"
+ ],
+ "x-ms-enum": {
+ "name": "ExpressionEvaluationOptionsScopeType",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template."
+ },
+ "ZoneMapping": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location of the zone mapping."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ScopeParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource scope.",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
+ },
+ "GroupIdParameter": {
+ "name": "groupId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The management group ID.",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription."
+ },
+ "DeploymentNameParameter": {
+ "name": "deploymentName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the deployment."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation."
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
new file mode 100644
index 000000000000..3e83a8bd8f27
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -0,0 +1,847 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "SubscriptionClient",
+ "version": "2021-01-01",
+ "description": "All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization."
+ },
+ "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}/locations": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_ListLocations",
+ "summary": "Gets all available geo-locations.",
+ "description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "includeExtendedLocations",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Whether to include extended locations.",
+ "x-ms-parameter-location": "method"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of locations.",
+ "schema": {
+ "$ref": "#/definitions/LocationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "GetLocationsWithASubscriptionId": {
+ "$ref": "./examples/GetLocations.json"
+ },
+ "GetLocationsWithExtendedLocations": {
+ "$ref": "./examples/GetLocationsWithExtendedLocations.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_Get",
+ "description": "Gets details about a specified subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the subscription.",
+ "schema": {
+ "$ref": "#/definitions/Subscription"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetASingleSubscription": {
+ "$ref": "./examples/GetSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_List",
+ "description": "Gets all subscriptions for a tenant.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of subscriptions.",
+ "schema": {
+ "$ref": "#/definitions/SubscriptionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAllSubscriptions": {
+ "$ref": "./examples/GetSubscriptions.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/tenants": {
+ "get": {
+ "tags": [
+ "Tenants"
+ ],
+ "operationId": "Tenants_List",
+ "description": "Gets the tenants for your account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of tenants.",
+ "schema": {
+ "$ref": "#/definitions/TenantListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAllTenants": {
+ "$ref": "./examples/GetTenants.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/checkZonePeers/": {
+ "post": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_CheckZonePeers",
+ "description": "Compares a subscriptions logical zone mapping",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckZonePeersRequest"
+ },
+ "description": "Parameters for checking zone peers."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the logical availability zone mapping between subscriptions",
+ "schema": {
+ "$ref": "#/definitions/CheckZonePeersResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetLogicalZoneMapping": {
+ "$ref": "./examples/PostCheckZonePeers.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/checkResourceName": {
+ "post": {
+ "tags": [
+ "Tenants"
+ ],
+ "operationId": "checkResourceName",
+ "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word",
+ "summary": "Checks resource name validity",
+ "consumes": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/CheckResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns status as allowed or not.",
+ "schema": {
+ "$ref": "#/definitions/CheckResourceNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CheckValidityForAResourceName": {
+ "$ref": "./examples/CheckResourceName.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "PairedRegion": {
+ "description": "Information regarding paired region.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the paired region."
+ },
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ }
+ }
+ },
+ "LocationMetadata": {
+ "description": "Location metadata information",
+ "properties": {
+ "regionType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the region.",
+ "enum": [
+ "Physical",
+ "Logical"
+ ],
+ "x-ms-enum": {
+ "name": "RegionType",
+ "modelAsString": true
+ }
+ },
+ "regionCategory": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The category of the region.",
+ "enum": [
+ "Recommended",
+ "Extended",
+ "Other"
+ ],
+ "x-ms-enum": {
+ "name": "RegionCategory",
+ "modelAsString": true
+ }
+ },
+ "geographyGroup": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The geography group of the location."
+ },
+ "longitude": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The longitude of the location."
+ },
+ "latitude": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The latitude of the location."
+ },
+ "physicalLocation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The physical location of the Azure location."
+ },
+ "pairedRegion": {
+ "type": "array",
+ "description": "The regions paired to this region.",
+ "items": {
+ "$ref": "#/definitions/PairedRegion"
+ }
+ },
+ "homeLocation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The home location of an edge zone."
+ }
+ }
+ },
+ "Location": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The location name."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The location type.",
+ "enum": [
+ "Region",
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "LocationType",
+ "modelAsString": false
+ }
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the location."
+ },
+ "regionalDisplayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the location and its region."
+ },
+ "metadata": {
+ "description": "Metadata of the location, such as lat/long, paired region, and others.",
+ "$ref": "#/definitions/LocationMetadata"
+ }
+ },
+ "description": "Location information."
+ },
+ "LocationListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Location"
+ },
+ "description": "An array of locations."
+ }
+ },
+ "description": "Location list operation response."
+ },
+ "Subscription": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription display name."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription tenant ID."
+ },
+ "state": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.",
+ "enum": [
+ "Enabled",
+ "Warned",
+ "PastDue",
+ "Disabled",
+ "Deleted"
+ ],
+ "x-ms-enum": {
+ "name": "SubscriptionState",
+ "modelAsString": false
+ }
+ },
+ "subscriptionPolicies": {
+ "$ref": "#/definitions/SubscriptionPolicies",
+ "description": "The subscription policies."
+ },
+ "authorizationSource": {
+ "type": "string",
+ "description": "The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'."
+ },
+ "managedByTenants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedByTenant"
+ },
+ "x-ms-identifiers": [
+ "tenantId"
+ ],
+ "description": "An array containing the tenants managing the subscription."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the subscription."
+ }
+ },
+ "description": "Subscription information."
+ },
+ "SubscriptionPolicies": {
+ "properties": {
+ "locationPlacementId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions."
+ },
+ "quotaId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription quota ID."
+ },
+ "spendingLimit": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription spending limit.",
+ "enum": [
+ "On",
+ "Off",
+ "CurrentPeriodOff"
+ ],
+ "x-ms-enum": {
+ "name": "spendingLimit",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Subscription policies."
+ },
+ "ManagedByTenant": {
+ "properties": {
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID of the managing tenant. This is a GUID."
+ }
+ },
+ "description": "Information about a tenant managing the subscription."
+ },
+ "SubscriptionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Subscription"
+ },
+ "description": "An array of subscriptions."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of results."
+ }
+ },
+ "required": [
+ "nextLink"
+ ],
+ "description": "Subscription list operation response."
+ },
+ "TenantIdDescription": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID. For example, 00000000-0000-0000-0000-000000000000."
+ },
+ "tenantCategory": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Category of the tenant.",
+ "enum": [
+ "Home",
+ "ProjectedBy",
+ "ManagedBy"
+ ],
+ "x-ms-enum": {
+ "name": "TenantCategory",
+ "modelAsString": false
+ }
+ },
+ "country": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Country/region name of the address for the tenant."
+ },
+ "countryCode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Country/region abbreviation for the tenant."
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the tenant."
+ },
+ "domains": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "The domain name for a tenant."
+ },
+ "description": "The list of domains for the tenant."
+ },
+ "defaultDomain": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The default domain for the tenant."
+ },
+ "tenantType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant type. Only available for 'Home' tenant category."
+ },
+ "tenantBrandingLogoUrl": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant's branding logo URL. Only available for 'Home' tenant category."
+ }
+ },
+ "description": "Tenant Id information."
+ },
+ "TenantListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TenantIdDescription"
+ },
+ "description": "An array of tenants."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "required": [
+ "nextLink"
+ ],
+ "description": "Tenant Ids information."
+ },
+ "ResourceName": {
+ "description": "Name and Type of the Resource",
+ "required": [
+ "name",
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the resource",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the resource"
+ }
+ }
+ },
+ "CheckResourceNameResult": {
+ "properties": {
+ "name": {
+ "description": "Name of Resource",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of Resource",
+ "type": "string"
+ },
+ "status": {
+ "description": "Is the resource name Allowed or Reserved",
+ "type": "string",
+ "enum": [
+ "Allowed",
+ "Reserved"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceNameStatus",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word"
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "An error response for a resource management request."
+ },
+ "Operation": {
+ "description": "Microsoft.Resources operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Microsoft.Resources 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"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "List of Microsoft.Resources operations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "CheckZonePeersRequest": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The Microsoft location."
+ },
+ "subscriptionIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The peer Microsoft Azure subscription ID."
+ }
+ },
+ "description": "Check zone peers request parameters."
+ },
+ "CheckZonePeersResult": {
+ "type": "object",
+ "description": "Result of the Check zone peers operation.",
+ "properties": {
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "location": {
+ "type": "string",
+ "description": "the location of the subscription."
+ },
+ "availabilityZonePeers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AvailabilityZonePeers"
+ },
+ "x-ms-identifiers": [
+ "availabilityZone"
+ ],
+ "description": "The Availability Zones shared by the subscriptions."
+ }
+ }
+ },
+ "AvailabilityZonePeers": {
+ "type": "object",
+ "properties": {
+ "availabilityZone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The availabilityZone."
+ },
+ "peers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Peers"
+ },
+ "x-ms-identifiers": [
+ "availabilityZone",
+ "subscriptionId"
+ ],
+ "description": "Details of shared availability zone."
+ }
+ },
+ "description": "List of availability zones shared by the subscriptions."
+ },
+ "Peers": {
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "availabilityZone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The availabilityZone."
+ }
+ },
+ "description": "Information about shared availability zone."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription.",
+ "x-ms-parameter-location": "method"
+ },
+ "CheckResourceNameParameter": {
+ "description": "Resource object with values for resource name and resource type",
+ "in": "body",
+ "name": "Resource Name Definition",
+ "schema": {
+ "$ref": "#/definitions/ResourceName"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-parameter-location": "client"
+ }
+ }
+}
From 3d0f83e723d4dd257b53b02d7415395f138acf52 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar <32332608+gauravkumar1491@users.noreply.github.com>
Date: Thu, 23 Mar 2023 16:26:50 -0700
Subject: [PATCH 02/37] Updates readme
---
.../resources/resource-manager/readme.md | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index bbf4732e39b2..6771f72318ae 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -74,9 +74,19 @@ tag: package-changes-2022-05
```
``` yaml $(package-snapshots)
-tag: package-snapshots-2022-11
+tag: package-2022-12
```
+
+### Tag: package-2022-12
+
+These settings apply only when `--tag=package-2022-12` is specified on the command line.
+
+```yaml $(tag) == 'package-2022-12'
+input-file:
+ - Microsoft.Resources/stable/2022-12-01/resources.json
+ - Microsoft.Resources/stable/2022-12-01/subscriptions.json
+```
### Tag: package-policy-2022-06
These settings apply only when `--tag=package-policy-2022-06` is specified on the command line.
@@ -185,6 +195,7 @@ input-file:
override-info:
title: PolicyClient
```
+
### Tag: package-locks-2017-04
These settings apply only when `--tag=package-locks-2017-04` is specified on the command line.
@@ -194,7 +205,6 @@ input-file:
- Microsoft.Authorization/stable/2017-04-01/locks.json
```
-
### Tag: package-preview-2020-08
These settings apply only when `--tag=package-preview-2020-08` is specified on the command line.
@@ -204,7 +214,6 @@ input-file:
- Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json
```
-
### Tag: package-subscriptions-2021-01
These settings apply only when `--tag=package-subscriptions-2021-01` is specified on the command line.
@@ -214,7 +223,6 @@ input-file:
- Microsoft.Resources/stable/2021-01-01/subscriptions.json
```
-
### Tag: package-deploymentscripts-2020-10
These settings apply only when `--tag=package-deploymentscripts-2020-10` is specified on the command line.
@@ -972,6 +980,7 @@ swagger-to-sdk:
- repo: azure-resource-manager-schemas
- repo: azure-powershell
```
+
## Python
See configuration in [readme.python.md](./readme.python.md)
@@ -1019,4 +1028,3 @@ input-file:
override-info:
title: PolicyClient
```
-
From 662e5b88ad8d77dd6d6b4be82ca1a04adb0fe4e9 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar <32332608+gauravkumar1491@users.noreply.github.com>
Date: Thu, 23 Mar 2023 16:26:53 -0700
Subject: [PATCH 03/37] Updates API version in new specs and examples
---
.../stable/2022-12-01/examples/CalculateTemplateHash.json | 2 +-
.../stable/2022-12-01/examples/CheckResourceName.json | 2 +-
.../stable/2022-12-01/examples/CreateResourceGroup.json | 2 +-
.../stable/2022-12-01/examples/ExportResourceGroup.json | 2 +-
.../2022-12-01/examples/ExportResourceGroupWithFiltering.json | 2 +-
.../stable/2022-12-01/examples/GetLocations.json | 2 +-
.../2022-12-01/examples/GetLocationsWithExtendedLocations.json | 2 +-
.../stable/2022-12-01/examples/GetNamedProviderAtTenant.json | 2 +-
.../stable/2022-12-01/examples/GetProvider.json | 2 +-
.../stable/2022-12-01/examples/GetProviderResourceTypes.json | 2 +-
.../stable/2022-12-01/examples/GetProviders.json | 2 +-
.../stable/2022-12-01/examples/GetSubscription.json | 2 +-
.../stable/2022-12-01/examples/GetSubscriptions.json | 2 +-
.../stable/2022-12-01/examples/GetTagsResource.json | 2 +-
.../stable/2022-12-01/examples/GetTagsSubscription.json | 2 +-
.../stable/2022-12-01/examples/GetTenants.json | 2 +-
.../stable/2022-12-01/examples/PostCheckZonePeers.json | 2 +-
.../examples/PostDeploymentWhatIfOnManagementGroup.json | 2 +-
.../examples/PostDeploymentWhatIfOnResourceGroup.json | 2 +-
.../2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json | 2 +-
.../2022-12-01/examples/PostDeploymentWhatIfOnTenant.json | 2 +-
.../2022-12-01/examples/PutDeploymentAtManagementGroup.json | 2 +-
.../stable/2022-12-01/examples/PutDeploymentAtScope.json | 2 +-
.../stable/2022-12-01/examples/PutDeploymentAtTenant.json | 2 +-
.../stable/2022-12-01/examples/PutDeploymentResourceGroup.json | 2 +-
.../examples/PutDeploymentResourceGroupTemplateSpecsWithId.json | 2 +-
.../examples/PutDeploymentSubscriptionTemplateSpecsWithId.json | 2 +-
.../PutDeploymentWithOnErrorDeploymentLastSuccessful.json | 2 +-
.../PutDeploymentWithOnErrorDeploymentSpecificDeployment.json | 2 +-
.../stable/2022-12-01/examples/PutTagsResource.json | 2 +-
.../stable/2022-12-01/examples/PutTagsSubscription.json | 2 +-
.../Microsoft.Resources/stable/2022-12-01/resources.json | 2 +-
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
33 files changed, 33 insertions(+), 33 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
index d1f83634bd30..f028ed6a82d9 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"template": {
"$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
"contentVersion": "1.0.0.0",
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
index 45b60e3b9971..9c98c9737641 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
@@ -6,7 +6,7 @@
"Type": "ResourceProviderTestHost/TestResourceType"
}
],
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
index 74398d45af47..a713e0e9dacb 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "my-resource-group",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus"
}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
index 5c3a43383fd1..b8a0fc247e92 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "my-resource-group",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"resources": [
"*"
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
index b70a6c3b1c65..6451335df801 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "my-resource-group",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"resources": [
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
index 445f660c0b38..508230ca4b3c 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
index ded38f8b6a21..bb9cc48fa5f8 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"includeExtendedLocations": "true"
},
"responses": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
index 86573a1566d2..7343b6a90d0a 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
@@ -2,7 +2,7 @@
"parameters": {
"$expand": "resourceTypes/aliases",
"resourceProviderNamespace": "Microsoft.Storage",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
index c56e92960fbc..584abd44e259 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceProviderNamespace": "Microsoft.TestRP1",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
index bbb9260ba33a..bfb5ec72716c 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceProviderNamespace": "Microsoft.TestRP",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
index 20756d3a8b52..27ddc0015c8d 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
index f62a28551dcc..4cde7276b823 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
index b340788d7eee..7b8737b095f4 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
index b66f222eb0af..b51eba832ae5 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
@@ -1,7 +1,7 @@
{
"parameters": {
"scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
index 625262aec894..43f93617317b 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
@@ -1,7 +1,7 @@
{
"parameters": {
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
index 553693bbc1e4..322dfa19b610 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
index fd52e3c1b2e6..3e2282e59be9 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-00000000000000",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"subscriptionIds": [
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
index 3439446e7254..291e2019a779 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
@@ -2,7 +2,7 @@
"parameters": {
"groupId": "myManagementGruop",
"deploymentName": "exampleDeploymentName",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
index f8d370feeb6a..2591a761c82a 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
@@ -3,7 +3,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"resourceGroupName": "my-resource-group",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"templateLink": "https://example.com/exampleTemplate.json",
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
index 1178815a7bfd..86e7241b2a95 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "westus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
index 0fcab3e885a1..38f42ea09fbf 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
@@ -1,7 +1,7 @@
{
"parameters": {
"deploymentName": "exampleDeploymentName",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
index 4e3566988164..0ba35b815a9b 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
@@ -2,7 +2,7 @@
"parameters": {
"groupId": "my-management-group-id",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
index 3c0c649f4c06..34dc0546bb54 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
@@ -2,7 +2,7 @@
"parameters": {
"scope": "providers/Microsoft.Management/managementGroups/my-management-group-id",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
index e610b895cb91..7593a8d1a8b8 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
@@ -1,7 +1,7 @@
{
"parameters": {
"deploymentName": "tenant-dep01",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
index 00357457df8b..c46a87591176 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
@@ -3,7 +3,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"resourceGroupName": "my-resource-group",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"templateLink": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
index e92197398583..814c8664839b 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
@@ -3,7 +3,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"resourceGroupName": "my-resource-group",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"templateLink": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
index 176551e6c9b2..1c6b228481af 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
@@ -2,7 +2,7 @@
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000001",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"location": "eastus",
"properties": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
index 9ff4e6e5c909..25b06868ca06 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
@@ -3,7 +3,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "my-resource-group",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"templateLink": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
index 1d735cd878fd..be56b7a76487 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
@@ -3,7 +3,7 @@
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "my-resource-group",
"deploymentName": "my-deployment",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"templateLink": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
index 39b2f5583b88..ea6697821841 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
@@ -1,7 +1,7 @@
{
"parameters": {
"scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"tags": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
index d193c0a7e661..78a72c3d436c 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
@@ -1,7 +1,7 @@
{
"parameters": {
"scope": "subscriptions/00000000-0000-0000-0000-000000000000",
- "api-version": "2021-01-01",
+ "api-version": "2022-12-01",
"parameters": {
"properties": {
"tags": {
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
index 2b1e32082928..ee3f87e7f348 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
@@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "ResourceManagementClient",
- "version": "2021-01-01",
+ "version": "2022-12-01",
"description": "Provides operations for working with resources and resource groups."
},
"host": "management.azure.com",
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 3e83a8bd8f27..e8792e1ae99a 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "SubscriptionClient",
- "version": "2021-01-01",
+ "version": "2022-12-01",
"description": "All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization."
},
"host": "management.azure.com",
From d3c78ff8cc24da6815e2cff0e5156e1e629e1393 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 24 Mar 2023 18:01:14 -0700
Subject: [PATCH 04/37] Adding new version 2022-12-01 for Locations API
---
.../examples/CheckResourceName.json | 20 +
.../2022-12-01/examples/GetLocations.json | 84 ++
.../GetLocationsWithExtendedLocations.json | 114 +++
.../2022-12-01/examples/GetSubscription.json | 32 +
.../2022-12-01/examples/GetSubscriptions.json | 61 ++
.../2022-12-01/examples/GetTenants.json | 53 ++
.../examples/PostCheckZonePeers.json | 49 +
.../stable/2022-12-01/subscriptions.json | 874 ++++++++++++++++++
.../resources/resource-manager/readme.md | 11 +-
9 files changed, 1297 insertions(+), 1 deletion(-)
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
new file mode 100644
index 000000000000..45b60e3b9971
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CheckResourceName.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "body": [
+ {
+ "Name": "isxbox",
+ "Type": "ResourceProviderTestHost/TestResourceType"
+ }
+ ],
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "name": "isxbox",
+ "type": "ResourceProviderTestHost/TestResourceType",
+ "status": "Allowed"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
new file mode 100644
index 000000000000..299f665c02a6
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "a1ffc958-d2c7-493e-9f1e-125a0477f536",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus-az2"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus2-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus2-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus2-az2"
+ }
+ ]
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
new file mode 100644
index 000000000000..d5d6aa7c9cf4
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
@@ -0,0 +1,114 @@
+{
+ "parameters": {
+ "subscriptionId": "a1ffc958-d2c7-493e-9f1e-125a0477f536",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": [
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus-az2"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus2-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus2-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus2-az2"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1",
+ "name": "ezecustomerlabboston1",
+ "type": "EdgeZone",
+ "displayName": "EZE Customer Lab Boston 1",
+ "regionalDisplayName": "(US) EZE Customer Lab Boston 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "geographyGroup": "US",
+ "geography": "United States",
+ "longitude": "-71.219038",
+ "latitude": "42.301218"
+ }
+ },
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1",
+ "name": "ezecustomerlabhouston1",
+ "type": "EdgeZone",
+ "displayName": "EZE Customer Lab Houston 1",
+ "regionalDisplayName": "(US) EZE Customer Lab Houston 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "geographyGroup": "US",
+ "geography": "United States",
+ "longitude": "-95.41452",
+ "latitude": "29.9411"
+ }
+ }
+ ]
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
new file mode 100644
index 000000000000..f62a28551dcc
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
+ "displayName": "Example Subscription",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "Bypassed",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
new file mode 100644
index 000000000000..b340788d7eee
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
@@ -0,0 +1,61 @@
+{
+ "parameters": {
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
+ "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
+ "displayName": "Example Subscription",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "RoleBased",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ },
+ {
+ "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
+ "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
+ "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c",
+ "displayName": "Example Subscription2",
+ "state": "Enabled",
+ "subscriptionPolicies": {
+ "locationPlacementId": "Internal_2014-09-01",
+ "quotaId": "Internal_2014-09-01",
+ "spendingLimit": "Off"
+ },
+ "authorizationSource": "RoleBased",
+ "managedByTenants": [
+ {
+ "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
+ },
+ {
+ "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
+ }
+ ],
+ "tags": {
+ "tagKey1": "tagValue1",
+ "tagKey2": "tagValue2"
+ }
+ }
+ ],
+ "nextLink": "..."
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
new file mode 100644
index 000000000000..553693bbc1e4
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTenants.json
@@ -0,0 +1,53 @@
+{
+ "parameters": {
+ "api-version": "2021-01-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
+ "tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
+ "countryCode": "US",
+ "displayName": "Test_Test_aad50",
+ "domains": [
+ "aad50.ccsctp.net"
+ ],
+ "tenantCategory": "ManagedBy",
+ "defaultDomain": "aad50.ccsctp.net",
+ "tenantType": "AAD"
+ },
+ {
+ "id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
+ "countryCode": "US",
+ "displayName": "Contoso Corp.",
+ "domains": [
+ "auxteststagemanual.ccsctp.net"
+ ],
+ "tenantCategory": "Home",
+ "defaultDomain": "auxteststagemanual.ccsctp.net",
+ "tenantType": "AAD"
+ },
+ {
+ "id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
+ "tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
+ "countryCode": "US",
+ "displayName": "TEST_TEST_RDV",
+ "domains": [
+ "rdvmohoro.ccsctp.net",
+ "rdvmohoro.mail.ccsctp.net",
+ "rdvmohoro.com"
+ ],
+ "tenantCategory": "ProjectedBy",
+ "defaultDomain": "rdvmohoro.ccsctp.net",
+ "tenantType": "AAD",
+ "tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com"
+ }
+ ],
+ "nextLink": "..."
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
new file mode 100644
index 000000000000..fd52e3c1b2e6
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
@@ -0,0 +1,49 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "api-version": "2021-01-01",
+ "parameters": {
+ "location": "eastus",
+ "subscriptionIds": [
+ "subscriptions/11111111-1111-1111-1111-111111111111"
+ ]
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "location": "eastus2",
+ "availabilityZonePeers": [
+ {
+ "availabilityZone": "1",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "3"
+ }
+ ]
+ },
+ {
+ "availabilityZone": "2",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "2"
+ }
+ ]
+ },
+ {
+ "availabilityZone": "3",
+ "peers": [
+ {
+ "subscriptionId": "11111111-1111-1111-1111-111111111111",
+ "availabilityZone": "1"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
new file mode 100644
index 000000000000..8169b08c2f49
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -0,0 +1,874 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "SubscriptionClient",
+ "version": "2021-01-01",
+ "description": "All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization."
+ },
+ "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}/locations": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_ListLocations",
+ "summary": "Gets all available geo-locations.",
+ "description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "includeExtendedLocations",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "description": "Whether to include extended locations.",
+ "x-ms-parameter-location": "method"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of locations.",
+ "schema": {
+ "$ref": "#/definitions/LocationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": null
+ },
+ "x-ms-examples": {
+ "GetLocationsWithASubscriptionId": {
+ "$ref": "./examples/GetLocations.json"
+ },
+ "GetLocationsWithExtendedLocations": {
+ "$ref": "./examples/GetLocationsWithExtendedLocations.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_Get",
+ "description": "Gets details about a specified subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the subscription.",
+ "schema": {
+ "$ref": "#/definitions/Subscription"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetASingleSubscription": {
+ "$ref": "./examples/GetSubscription.json"
+ }
+ }
+ }
+ },
+ "/subscriptions": {
+ "get": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_List",
+ "description": "Gets all subscriptions for a tenant.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of subscriptions.",
+ "schema": {
+ "$ref": "#/definitions/SubscriptionListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAllSubscriptions": {
+ "$ref": "./examples/GetSubscriptions.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/tenants": {
+ "get": {
+ "tags": [
+ "Tenants"
+ ],
+ "operationId": "Tenants_List",
+ "description": "Gets the tenants for your account.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of tenants.",
+ "schema": {
+ "$ref": "#/definitions/TenantListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetAllTenants": {
+ "$ref": "./examples/GetTenants.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/checkZonePeers/": {
+ "post": {
+ "tags": [
+ "Subscriptions"
+ ],
+ "operationId": "Subscriptions_CheckZonePeers",
+ "description": "Compares a subscriptions logical zone mapping",
+ "parameters": [
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CheckZonePeersRequest"
+ },
+ "description": "Parameters for checking zone peers."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the logical availability zone mapping between subscriptions",
+ "schema": {
+ "$ref": "#/definitions/CheckZonePeersResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "GetLogicalZoneMapping": {
+ "$ref": "./examples/PostCheckZonePeers.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/checkResourceName": {
+ "post": {
+ "tags": [
+ "Tenants"
+ ],
+ "operationId": "checkResourceName",
+ "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word",
+ "summary": "Checks resource name validity",
+ "consumes": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/CheckResourceNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns status as allowed or not.",
+ "schema": {
+ "$ref": "#/definitions/CheckResourceNameResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "CheckValidityForAResourceName": {
+ "$ref": "./examples/CheckResourceName.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "PairedRegion": {
+ "description": "Information regarding paired region.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The name of the paired region."
+ },
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ }
+ }
+ },
+ "AvailabilityZoneMappings": {
+ "description": "Availability zone mappings for the region",
+ "properties": {
+ "logicalZone": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The logical zone id for the availability zone"
+ },
+ "physicalZone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified physical zone id of availability zone to which logical zone id is mapped to"
+ }
+ }
+ },
+ "LocationMetadata": {
+ "description": "Location metadata information",
+ "properties": {
+ "regionType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the region.",
+ "enum": [
+ "Physical",
+ "Logical"
+ ],
+ "x-ms-enum": {
+ "name": "RegionType",
+ "modelAsString": true
+ }
+ },
+ "regionCategory": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The category of the region.",
+ "enum": [
+ "Recommended",
+ "Extended",
+ "Other"
+ ],
+ "x-ms-enum": {
+ "name": "RegionCategory",
+ "modelAsString": true
+ }
+ },
+ "geography": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The geography of the location."
+ },
+ "geographyGroup": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The geography group of the location."
+ },
+ "longitude": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The longitude of the location."
+ },
+ "latitude": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The latitude of the location."
+ },
+ "physicalLocation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The physical location of the Azure location."
+ },
+ "pairedRegion": {
+ "type": "array",
+ "description": "The regions paired to this region.",
+ "items": {
+ "$ref": "#/definitions/PairedRegion"
+ }
+ },
+ "homeLocation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The home location of an edge zone."
+ }
+ }
+ },
+ "Location": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The location name."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The location type.",
+ "enum": [
+ "Region",
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "LocationType",
+ "modelAsString": false
+ }
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the location."
+ },
+ "regionalDisplayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the location and its region."
+ },
+ "metadata": {
+ "description": "Metadata of the location, such as lat/long, paired region, and others.",
+ "$ref": "#/definitions/LocationMetadata"
+ },
+ "availabilityZoneMappings": {
+ "type": "array",
+ "description": "The availability zone mappings for this region.",
+ "items": {
+ "$ref": "#/definitions/AvailabilityZoneMappings"
+ }
+ }
+ },
+ "description": "Location information."
+ },
+ "LocationListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Location"
+ },
+ "description": "An array of locations."
+ }
+ },
+ "description": "Location list operation response."
+ },
+ "Subscription": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000."
+ },
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription display name."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription tenant ID."
+ },
+ "state": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.",
+ "enum": [
+ "Enabled",
+ "Warned",
+ "PastDue",
+ "Disabled",
+ "Deleted"
+ ],
+ "x-ms-enum": {
+ "name": "SubscriptionState",
+ "modelAsString": false
+ }
+ },
+ "subscriptionPolicies": {
+ "$ref": "#/definitions/SubscriptionPolicies",
+ "description": "The subscription policies."
+ },
+ "authorizationSource": {
+ "type": "string",
+ "description": "The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'."
+ },
+ "managedByTenants": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ManagedByTenant"
+ },
+ "x-ms-identifiers": [
+ "tenantId"
+ ],
+ "description": "An array containing the tenants managing the subscription."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the subscription."
+ }
+ },
+ "description": "Subscription information."
+ },
+ "SubscriptionPolicies": {
+ "properties": {
+ "locationPlacementId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions."
+ },
+ "quotaId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription quota ID."
+ },
+ "spendingLimit": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription spending limit.",
+ "enum": [
+ "On",
+ "Off",
+ "CurrentPeriodOff"
+ ],
+ "x-ms-enum": {
+ "name": "spendingLimit",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Subscription policies."
+ },
+ "ManagedByTenant": {
+ "properties": {
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID of the managing tenant. This is a GUID."
+ }
+ },
+ "description": "Information about a tenant managing the subscription."
+ },
+ "SubscriptionListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Subscription"
+ },
+ "description": "An array of subscriptions."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to get the next set of results."
+ }
+ },
+ "required": [
+ "nextLink"
+ ],
+ "description": "Subscription list operation response."
+ },
+ "TenantIdDescription": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID. For example, 00000000-0000-0000-0000-000000000000."
+ },
+ "tenantCategory": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Category of the tenant.",
+ "enum": [
+ "Home",
+ "ProjectedBy",
+ "ManagedBy"
+ ],
+ "x-ms-enum": {
+ "name": "TenantCategory",
+ "modelAsString": false
+ }
+ },
+ "country": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Country/region name of the address for the tenant."
+ },
+ "countryCode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Country/region abbreviation for the tenant."
+ },
+ "displayName": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The display name of the tenant."
+ },
+ "domains": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "type": "string",
+ "description": "The domain name for a tenant."
+ },
+ "description": "The list of domains for the tenant."
+ },
+ "defaultDomain": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The default domain for the tenant."
+ },
+ "tenantType": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant type. Only available for 'Home' tenant category."
+ },
+ "tenantBrandingLogoUrl": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant's branding logo URL. Only available for 'Home' tenant category."
+ }
+ },
+ "description": "Tenant Id information."
+ },
+ "TenantListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TenantIdDescription"
+ },
+ "description": "An array of tenants."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "required": [
+ "nextLink"
+ ],
+ "description": "Tenant Ids information."
+ },
+ "ResourceName": {
+ "description": "Name and Type of the Resource",
+ "required": [
+ "name",
+ "type"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the resource",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the resource"
+ }
+ }
+ },
+ "CheckResourceNameResult": {
+ "properties": {
+ "name": {
+ "description": "Name of Resource",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of Resource",
+ "type": "string"
+ },
+ "status": {
+ "description": "Is the resource name Allowed or Reserved",
+ "type": "string",
+ "enum": [
+ "Allowed",
+ "Reserved"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceNameStatus",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word"
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "An error response for a resource management request."
+ },
+ "Operation": {
+ "description": "Microsoft.Resources operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Microsoft.Resources 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"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "List of Microsoft.Resources operations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "CheckZonePeersRequest": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The Microsoft location."
+ },
+ "subscriptionIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The peer Microsoft Azure subscription ID."
+ }
+ },
+ "description": "Check zone peers request parameters."
+ },
+ "CheckZonePeersResult": {
+ "type": "object",
+ "description": "Result of the Check zone peers operation.",
+ "properties": {
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "location": {
+ "type": "string",
+ "description": "the location of the subscription."
+ },
+ "availabilityZonePeers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AvailabilityZonePeers"
+ },
+ "x-ms-identifiers": [
+ "availabilityZone"
+ ],
+ "description": "The Availability Zones shared by the subscriptions."
+ }
+ }
+ },
+ "AvailabilityZonePeers": {
+ "type": "object",
+ "properties": {
+ "availabilityZone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The availabilityZone."
+ },
+ "peers": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Peers"
+ },
+ "x-ms-identifiers": [
+ "availabilityZone",
+ "subscriptionId"
+ ],
+ "description": "Details of shared availability zone."
+ }
+ },
+ "description": "List of availability zones shared by the subscriptions."
+ },
+ "Peers": {
+ "type": "object",
+ "properties": {
+ "subscriptionId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The subscription ID."
+ },
+ "availabilityZone": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The availabilityZone."
+ }
+ },
+ "description": "Information about shared availability zone."
+ }
+ },
+ "parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription.",
+ "x-ms-parameter-location": "method"
+ },
+ "CheckResourceNameParameter": {
+ "description": "Resource object with values for resource name and resource type",
+ "in": "body",
+ "name": "Resource Name Definition",
+ "schema": {
+ "$ref": "#/definitions/ResourceName"
+ },
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-parameter-location": "client"
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index bbf4732e39b2..ca827bef652c 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -50,7 +50,7 @@ tag: package-resources-2022-09
```
``` yaml $(package-subscriptions)
-tag: package-subscriptions-2021-01
+tag: package-subscriptions-2022-12
```
``` yaml $(package-links)
@@ -204,6 +204,15 @@ input-file:
- Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json
```
+### Tag: package-subscriptions-2022-12
+
+These settings apply only when `--tag=package-subscriptions-2022-12` is specified on the command line.
+
+``` yaml $(tag) == 'package-subscriptions-2022-12'
+input-file:
+- Microsoft.Resources/stable/2022-12-01/subscriptions.json
+```
+
### Tag: package-subscriptions-2021-01
From 52a1c86d72653e95e846ad25a6afdac0991c0d8e Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 24 Mar 2023 18:26:02 -0700
Subject: [PATCH 05/37] Correct version
---
.../stable/2022-12-01/examples/GetSubscription.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
index f62a28551dcc..4cde7276b823 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscription.json
@@ -1,7 +1,7 @@
{
"parameters": {
"subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
- "api-version": "2021-01-01"
+ "api-version": "2022-12-01"
},
"responses": {
"200": {
From 04b319181219f52115618f3a5aaa7a58ed3e3a58 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 24 Mar 2023 18:37:19 -0700
Subject: [PATCH 06/37] removing resources.json from readme
---
specification/resources/resource-manager/readme.md | 1 -
1 file changed, 1 deletion(-)
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index bd6c87d3bdd6..d1688d2e0117 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -84,7 +84,6 @@ These settings apply only when `--tag=package-2022-12` is specified on the comma
```yaml $(tag) == 'package-2022-12'
input-file:
- - Microsoft.Resources/stable/2022-12-01/resources.json
- Microsoft.Resources/stable/2022-12-01/subscriptions.json
```
### Tag: package-policy-2022-06
From 00b3d6c16c0e58da3534261278364b990ea42265 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Mon, 27 Mar 2023 16:39:46 -0700
Subject: [PATCH 07/37] Review comment
---
specification/resources/resource-manager/readme.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md
index d1688d2e0117..2bf6d0672fb5 100644
--- a/specification/resources/resource-manager/readme.md
+++ b/specification/resources/resource-manager/readme.md
@@ -74,7 +74,7 @@ tag: package-changes-2022-05
```
``` yaml $(package-snapshots)
-tag: package-2022-12
+tag: package-snapshots-2022-11
```
From 92b6667be8958426672441e17ed54be1b7f3148d Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Tue, 28 Mar 2023 10:48:45 -0700
Subject: [PATCH 08/37] Validation error fixes
---
.../stable/2022-12-01/subscriptions.json | 22 +++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 0a5802aac447..0652225a7593 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -282,6 +282,7 @@
"definitions": {
"PairedRegion": {
"description": "Information regarding paired region.",
+ "type": "object",
"properties": {
"name": {
"type": "string",
@@ -302,6 +303,7 @@
},
"AvailabilityZoneMappings": {
"description": "Availability zone mappings for the region",
+ "type": "object",
"properties": {
"logicalZone": {
"type": "string",
@@ -317,6 +319,7 @@
},
"LocationMetadata": {
"description": "Location metadata information",
+ "type": "object",
"properties": {
"regionType": {
"readOnly": true,
@@ -385,6 +388,7 @@
}
},
"Location": {
+ "type": "object",
"properties": {
"id": {
"readOnly": true,
@@ -433,12 +437,14 @@
"description": "The availability zone mappings for this region.",
"items": {
"$ref": "#/definitions/AvailabilityZoneMappings"
- }
+ },
+ "x-ms-identifiers": []
}
},
"description": "Location information."
},
"LocationListResult": {
+ "type": "object",
"properties": {
"value": {
"type": "array",
@@ -451,6 +457,7 @@
"description": "Location list operation response."
},
"Subscription": {
+ "type": "object",
"properties": {
"id": {
"readOnly": true,
@@ -518,6 +525,7 @@
"description": "Subscription information."
},
"SubscriptionPolicies": {
+ "type": "object",
"properties": {
"locationPlacementId": {
"readOnly": true,
@@ -547,6 +555,7 @@
"description": "Subscription policies."
},
"ManagedByTenant": {
+ "type": "object",
"properties": {
"tenantId": {
"readOnly": true,
@@ -557,6 +566,7 @@
"description": "Information about a tenant managing the subscription."
},
"SubscriptionListResult": {
+ "type": "object",
"properties": {
"value": {
"type": "array",
@@ -576,6 +586,7 @@
"description": "Subscription list operation response."
},
"TenantIdDescription": {
+ "type": "object",
"properties": {
"id": {
"readOnly": true,
@@ -644,6 +655,7 @@
"description": "Tenant Id information."
},
"TenantListResult": {
+ "type": "object",
"properties": {
"value": {
"type": "array",
@@ -663,6 +675,7 @@
"description": "Tenant Ids information."
},
"ResourceName": {
+ "type": "object",
"description": "Name and Type of the Resource",
"required": [
"name",
@@ -680,6 +693,7 @@
}
},
"CheckResourceNameResult": {
+ "type": "object",
"properties": {
"name": {
"description": "Name of Resource",
@@ -705,6 +719,7 @@
"description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word"
},
"CloudError": {
+ "type": "object",
"x-ms-external": true,
"properties": {
"error": {
@@ -722,6 +737,7 @@
"type": "string"
},
"display": {
+ "type": "object",
"description": "The object that represents the operation.",
"properties": {
"provider": {
@@ -745,6 +761,7 @@
}
},
"OperationListResult": {
+ "type": "object",
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
@@ -791,7 +808,8 @@
},
"location": {
"type": "string",
- "description": "the location of the subscription."
+ "description": "the location of the subscription.",
+ "x-ms-mutability": [ "create", "read" ]
},
"availabilityZonePeers": {
"type": "array",
From 6a446c37f1b6ff5e21b13761a45d7d87ac6cd761 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Tue, 28 Mar 2023 11:05:45 -0700
Subject: [PATCH 09/37] Model Validation Fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 1 -
1 file changed, 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 0652225a7593..e7a9ac4e821f 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -444,7 +444,6 @@
"description": "Location information."
},
"LocationListResult": {
- "type": "object",
"properties": {
"value": {
"type": "array",
From 97708bad670d8246c2af729a29b715c2bcac01bf Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Tue, 28 Mar 2023 12:52:39 -0700
Subject: [PATCH 10/37] Validation Error fix test
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index e7a9ac4e821f..a0d675330c6f 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -444,6 +444,7 @@
"description": "Location information."
},
"LocationListResult": {
+ "type": "array",
"properties": {
"value": {
"type": "array",
From d8e14074e53e84530a0dbcc7208e005b888503cd Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Tue, 28 Mar 2023 13:07:23 -0700
Subject: [PATCH 11/37] small fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index a0d675330c6f..0652225a7593 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -444,7 +444,7 @@
"description": "Location information."
},
"LocationListResult": {
- "type": "array",
+ "type": "object",
"properties": {
"value": {
"type": "array",
From ba2dae3435c33036781b8f5073198cfc3d0d52c9 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Tue, 28 Mar 2023 22:21:45 -0700
Subject: [PATCH 12/37] Missing files
---
.../examples/CalculateTemplateHash.json | 46 +
.../examples/CreateResourceGroup.json | 32 +
.../examples/ExportResourceGroup.json | 68 +
.../ExportResourceGroupWithFiltering.json | 46 +
.../ForceDeleteVMsAndVMSSInResourceGroup.json | 16 +
.../ForceDeleteVMsInResourceGroup.json | 16 +
.../examples/GetNamedProviderAtTenant.json | 253 +
.../2022-12-01/examples/GetProvider.json | 51 +
.../examples/GetProviderResourceTypes.json | 47 +
.../2022-12-01/examples/GetProviders.json | 175 +
.../2022-12-01/examples/GetTagsResource.json | 18 +
.../examples/GetTagsSubscription.json | 18 +
...PostDeploymentWhatIfOnManagementGroup.json | 87 +
.../PostDeploymentWhatIfOnResourceGroup.json | 73 +
.../PostDeploymentWhatIfOnSubscription.json | 84 +
.../PostDeploymentWhatIfOnTenant.json | 40 +
.../PutDeploymentAtManagementGroup.json | 139 +
.../examples/PutDeploymentAtScope.json | 151 +
.../examples/PutDeploymentAtTenant.json | 150 +
.../examples/PutDeploymentResourceGroup.json | 93 +
...ymentResourceGroupTemplateSpecsWithId.json | 92 +
...oymentSubscriptionTemplateSpecsWithId.json | 66 +
...ntWithOnErrorDeploymentLastSuccessful.json | 168 +
...thOnErrorDeploymentSpecificDeployment.json | 169 +
.../2022-12-01/examples/PutTagsResource.json | 26 +
.../examples/PutTagsSubscription.json | 26 +
.../stable/2022-12-01/resources.json | 6446 +++++++++++++++++
27 files changed, 8596 insertions(+)
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
new file mode 100644
index 000000000000..f028ed6a82d9
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "api-version": "2022-12-01",
+ "template": {
+ "$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "string": {
+ "type": "string"
+ }
+ },
+ "variables": {
+ "string": "string",
+ "int": 42,
+ "bool": true,
+ "array": [
+ 1,
+ 2,
+ 3,
+ 4
+ ],
+ "object": {
+ "object": {
+ "vmSize": "Large",
+ "location": "West US"
+ }
+ }
+ },
+ "resources": [],
+ "outputs": {
+ "string": {
+ "type": "string",
+ "value": "myvalue"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "minifiedTemplate": "{\"$SCHEMA\":\"HTTP://SCHEMAS.MANAGEMENT.AZURE.COM/DEPLOYMENTTEMPLATE?API-VERSION=2014-04-01-PREVIEW\",\"CONTENTVERSION\":\"1.0.0.0\",\"PARAMETERS\":{\"STRING\":{\"TYPE\":\"STRING\"}},\"VARIABLES\":{\"STRING\":\"STRING\",\"INT\":42,\"BOOL\":TRUE,\"ARRAY\":[1,2,3,4],\"OBJECT\":{\"OBJECT\":{\"VMSIZE\":\"LARGE\",\"LOCATION\":\"WEST US\"}}},\"RESOURCES\":[],\"OUTPUTS\":{\"STRING\":{\"TYPE\":\"STRING\",\"VALUE\":\"MYVALUE\"}}}",
+ "templateHash": "695440707931307747"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
new file mode 100644
index 000000000000..a713e0e9dacb
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus"
+ }
+ },
+ "responses": {
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
+ "name": "my-resource-group",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ },
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
+ "name": "my-resource-group",
+ "location": "eastus",
+ "properties": {
+ "provisioningState": "Succeeded"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
new file mode 100644
index 000000000000..b8a0fc247e92
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
@@ -0,0 +1,68 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "resources": [
+ "*"
+ ],
+ "options": "IncludeParameterDefaultValue,IncludeComments"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
+ }
+ },
+ "200": {
+ "body": {
+ "template": {
+ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "myResourceType_myFirstResource_name": {
+ "defaultValue": "myFirstResource",
+ "type": "String"
+ },
+ "myResourceType_mySecondResource_name": {
+ "defaultValue": "mySecondResource",
+ "type": "String"
+ },
+ "myResourceType_myFirstResource_secret": {
+ "defaultValue": null,
+ "type": "SecureString"
+ }
+ },
+ "variables": {},
+ "resources": [
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "[parameters('myResourceType_myFirstResource_name')]",
+ "location": "West US",
+ "properties": {
+ "secret": "[parameters('myResourceType_myFirstResource_secret')]"
+ }
+ },
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "[parameters('myResourceType_mySecondResource_name')]",
+ "location": "West US",
+ "properties": {
+ "customProperty": "hello!"
+ }
+ }
+ ]
+ },
+ "error": {
+ "code": "ExportTemplateCompletedWithErrors",
+ "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.",
+ "details": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
new file mode 100644
index 000000000000..6451335df801
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
@@ -0,0 +1,46 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "resources": [
+ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
+ ],
+ "options": "SkipResourceNameParameterization"
+ }
+ },
+ "responses": {
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
+ }
+ },
+ "200": {
+ "body": {
+ "template": {
+ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
+ "contentVersion": "1.0.0.0",
+ "parameters": {
+ "myResourceType_myFirstResource_secret": {
+ "defaultValue": null,
+ "type": "SecureString"
+ }
+ },
+ "variables": {},
+ "resources": [
+ {
+ "type": "My.RP/myResourceType",
+ "apiVersion": "2019-01-01",
+ "name": "myFirstResource",
+ "location": "West US",
+ "properties": {
+ "secret": "[parameters('myResourceType_myFirstResource_secret')]"
+ }
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
new file mode 100644
index 000000000000..8a76d9a606ee
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "forceDeletionTypes": "Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "200": {
+ "description": "OK"
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
new file mode 100644
index 000000000000..2dc0365dac0d
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
@@ -0,0 +1,16 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "forceDeletionTypes": "Microsoft.Compute/virtualMachines",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "200": {
+ "description": "OK"
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
new file mode 100644
index 000000000000..7343b6a90d0a
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
@@ -0,0 +1,253 @@
+{
+ "parameters": {
+ "$expand": "resourceTypes/aliases",
+ "resourceProviderNamespace": "Microsoft.Storage",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "East US",
+ "East US 2",
+ "East US 2 (Stage)",
+ "West US",
+ "West Europe",
+ "East Asia",
+ "Southeast Asia",
+ "Japan East",
+ "Japan West",
+ "North Central US",
+ "South Central US",
+ "Central US",
+ "North Europe",
+ "Brazil South",
+ "Australia East",
+ "Australia Southeast",
+ "South India",
+ "Central India",
+ "West India",
+ "Canada East",
+ "Canada Central",
+ "West US 2",
+ "West Central US",
+ "UK South",
+ "UK West",
+ "Korea Central",
+ "Korea South",
+ "East US 2 EUAP",
+ "Central US EUAP",
+ "France Central",
+ "France South",
+ "Australia Central",
+ "Australia Central 2",
+ "South Africa West",
+ "South Africa North",
+ "UAE Central",
+ "UAE North",
+ "Switzerland North",
+ "Switzerland West",
+ "Germany West Central",
+ "Germany North",
+ "Norway East",
+ "Norway West",
+ "South Central US STG",
+ "Brazil Southeast"
+ ],
+ "apiVersions": [
+ "2019-06-01",
+ "2019-04-01",
+ "2018-11-01",
+ "2018-07-01",
+ "2018-03-01-preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ],
+ "defaultApiVersion": "2019-06-01",
+ "apiProfiles": [
+ {
+ "profileVersion": "2019-03-01-hybrid",
+ "apiVersion": "2017-10-01"
+ },
+ {
+ "profileVersion": "2017-03-09-profile",
+ "apiVersion": "2016-01-01"
+ },
+ {
+ "profileVersion": "2018-03-01-hybrid",
+ "apiVersion": "2016-01-01"
+ },
+ {
+ "profileVersion": "2018-06-01-profile",
+ "apiVersion": "2017-10-01"
+ }
+ ],
+ "aliases": [
+ {
+ "name": "Microsoft.Storage/storageAccounts/accountType",
+ "paths": [
+ {
+ "path": "properties.accountType",
+ "apiVersions": [
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ },
+ {
+ "path": "sku.name",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01"
+ ]
+ }
+ ],
+ "defaultPath": "sku.name"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/sku.name",
+ "paths": [
+ {
+ "path": "properties.accountType",
+ "apiVersions": [
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ },
+ {
+ "path": "sku.name",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01"
+ ]
+ }
+ ],
+ "defaultPath": "sku.name"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/accessTier",
+ "paths": [
+ {
+ "path": "properties.accessTier",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.accessTier"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/enableBlobEncryption",
+ "paths": [
+ {
+ "path": "properties.encryption.services.blob.enabled",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.encryption.services.blob.enabled"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/enableFileEncryption",
+ "paths": [
+ {
+ "path": "properties.encryption.services.file.enabled",
+ "apiVersions": [
+ "2018-11-01",
+ "2018-11-09",
+ "2018-07-01",
+ "2018-03-01-Preview",
+ "2018-02-01",
+ "2017-10-01",
+ "2017-06-01",
+ "2016-12-01",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ]
+ }
+ ],
+ "defaultPath": "properties.encryption.services.file.enabled"
+ },
+ {
+ "name": "Microsoft.Storage/storageAccounts/supportsHttpsTrafficOnly",
+ "paths": [
+ {
+ "path": "properties.supportsHttpsTrafficOnly",
+ "apiVersions": [
+ "2018-11-09",
+ "2018-03-01-Preview",
+ "2016-05-01",
+ "2016-01-01",
+ "2015-06-15",
+ "2015-05-01-preview"
+ ],
+ "metadata": {
+ "type": "NotSpecified",
+ "attributes": "None"
+ }
+ }
+ ],
+ "defaultPath": "properties.supportsHttpsTrafficOnly",
+ "defaultMetadata": {
+ "type": "Boolean",
+ "attributes": "Modifiable"
+ }
+ }
+ ],
+ "capabilities": "SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
new file mode 100644
index 000000000000..584abd44e259
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
@@ -0,0 +1,51 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceProviderNamespace": "Microsoft.TestRP1",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
+ "namespace": "Microsoft.TestRP1",
+ "registrationState": "Registering",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
new file mode 100644
index 000000000000..bfb5ec72716c
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
@@ -0,0 +1,47 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceProviderNamespace": "Microsoft.TestRP",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
new file mode 100644
index 000000000000..27ddc0015c8d
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
@@ -0,0 +1,175 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
+ "namespace": "Microsoft.TestRP1",
+ "registrationState": "Registering",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources",
+ "namespace": "Microsoft.Resources",
+ "registrationState": "Registered",
+ "registrationPolicy": "RegistrationFree",
+ "resourceTypes": [
+ {
+ "resourceType": "subscriptions",
+ "locations": [
+ "eastus",
+ "eastus2",
+ "westus"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "resourceGroups",
+ "locations": [
+ "centralus",
+ "eastasia",
+ "southeastasia"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "subscriptions/resourceGroups",
+ "locations": [
+ "eastus",
+ "eastus2",
+ "westus"
+ ],
+ "apiVersions": [
+ "2016-09-01",
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "bulkDelete",
+ "locations": [
+ "centralus",
+ "eastasia"
+ ],
+ "apiVersions": [
+ "2014-04-01-preview"
+ ],
+ "aliases": [],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "deployments",
+ "locations": [],
+ "apiVersions": [
+ "2017-08-01",
+ "2017-06-01"
+ ],
+ "aliases": [],
+ "capabilities": "SupportsTags"
+ },
+ {
+ "resourceType": "tags",
+ "locations": [
+ "DevFabric"
+ ],
+ "apiVersions": [],
+ "aliases": [],
+ "capabilities": "SupportsExtension"
+ }
+ ]
+ },
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP2",
+ "namespace": "Microsoft.TestRP2",
+ "registrationState": "NotRegistered",
+ "registrationPolicy": "RegistrationRequired",
+ "resourceTypes": [
+ {
+ "resourceType": "TestResourceType",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "locationMappings": [
+ {
+ "location": "West US",
+ "type": "EdgeZone",
+ "extendedLocations": [
+ "LosAngeles",
+ "LosAngeles2"
+ ]
+ }
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ },
+ {
+ "resourceType": "TestResourceTypeSibling",
+ "locations": [
+ "West US"
+ ],
+ "apiVersions": [
+ "2018-01-01",
+ "2015-05-01"
+ ],
+ "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
new file mode 100644
index 000000000000..b51eba832ae5
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
new file mode 100644
index 000000000000..43f93617317b
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
@@ -0,0 +1,18 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01"
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
new file mode 100644
index 000000000000..291e2019a779
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
@@ -0,0 +1,87 @@
+{
+ "parameters": {
+ "groupId": "myManagementGruop",
+ "deploymentName": "exampleDeploymentName",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
+ "enforcementMode": "Default"
+ }
+ },
+ "after": {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
+ "enforcementMode": "DoNotEnforce"
+ }
+ },
+ "delta": [
+ {
+ "path": "properties.enforcementMode",
+ "propertyChangeType": "Modify",
+ "before": "Default",
+ "after": "DoNotEnforce"
+ }
+ ]
+ }
+ },
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2019-06-01",
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
+ "type": "Microsoft.Authorization/policyAssignments",
+ "name": "myPolicyAssignment2",
+ "location": "westus2",
+ "properties": {
+ "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
+ "scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
+ "enforcementMode": "Default"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
new file mode 100644
index 000000000000..2591a761c82a
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
@@ -0,0 +1,73 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2"
+ },
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2",
+ "tags": {
+ "myNewTag": "my tag value"
+ }
+ },
+ "delta": [
+ {
+ "path": "tags.myNewTag",
+ "propertyChangeType": "Create",
+ "after": "my tag value"
+ }
+ ]
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myNewIdentity",
+ "location": "eastus",
+ "tags": {
+ "myOtherNewTag": "another new tag value"
+ }
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
new file mode 100644
index 000000000000..86e7241b2a95
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
@@ -0,0 +1,84 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "westus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "changeType": "Modify",
+ "before": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2"
+ },
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myExistingIdentity",
+ "location": "westus2",
+ "tags": {
+ "myNewTag": "my tag value"
+ }
+ },
+ "delta": [
+ {
+ "path": "tags.myNewTag",
+ "propertyChangeType": "Create",
+ "after": "my tag value"
+ }
+ ]
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2018-11-30",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
+ "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
+ "name": "myNewIdentity",
+ "location": "eastus",
+ "tags": {
+ "myOtherNewTag": "another new tag value"
+ }
+ }
+ },
+ {
+ "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
+ "changeType": "Create",
+ "after": {
+ "apiVersion": "2019-03-01",
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
+ "type": "Microsoft.Resources/resourceGroups",
+ "name": "my-resource-group2",
+ "location": "{location3}"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
new file mode 100644
index 000000000000..38f42ea09fbf
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
@@ -0,0 +1,40 @@
+{
+ "parameters": {
+ "deploymentName": "exampleDeploymentName",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": "https://example.com/exampleTemplate.json",
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "status": "Succeeded",
+ "properties": {
+ "changes": [
+ {
+ "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
+ "changeType": "Create",
+ "after": {
+ "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
+ "apiVersion": "2019-11-01",
+ "type": "Microsoft.Management/managementGroups",
+ "name": "myManagementGroup"
+ }
+ }
+ ]
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
new file mode 100644
index 000000000000..0ba35b815a9b
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
@@ -0,0 +1,139 @@
+{
+ "parameters": {
+ "groupId": "my-management-group-id",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
new file mode 100644
index 000000000000..34dc0546bb54
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
@@ -0,0 +1,151 @@
+{
+ "parameters": {
+ "scope": "providers/Microsoft.Management/managementGroups/my-management-group-id",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
new file mode 100644
index 000000000000..7593a8d1a8b8
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
@@ -0,0 +1,150 @@
+{
+ "parameters": {
+ "deploymentName": "tenant-dep01",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
+ "name": "tenant-dep01",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
+ "name": "tenant-dep01",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-04-24T22:52:38.7895563Z",
+ "duration": "PT1.2970875S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Authorization",
+ "resourceTypes": [
+ {
+ "resourceType": "policyDefinitions",
+ "locations": [
+ null
+ ]
+ },
+ {
+ "resourceType": "policyAssignments",
+ "locations": [
+ null
+ ]
+ }
+ ]
+ },
+ {
+ "namespace": "Microsoft.Resources",
+ "resourceTypes": [
+ {
+ "resourceType": "deployments",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
+ "resourceType": "Microsoft.Authorization/policyDefinitions",
+ "resourceName": "policy-definition-name"
+ }
+ ],
+ "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
+ "resourceType": "Microsoft.Authorization/policyAssignments",
+ "resourceName": "location-lock"
+ }
+ ]
+ },
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
new file mode 100644
index 000000000000..c46a87591176
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
@@ -0,0 +1,93 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [],
+ "outputResources": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
new file mode 100644
index 000000000000..814c8664839b
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
@@ -0,0 +1,92 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [],
+ "outputResources": [
+ {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
+ }
+ ]
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:20:01.723776Z",
+ "duration": "PT22.8356799S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Storage",
+ "resourceTypes": [
+ {
+ "resourceType": "storageAccounts",
+ "locations": [
+ "eastus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
new file mode 100644
index 000000000000..1c6b228481af
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
@@ -0,0 +1,66 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000001",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
+ },
+ "parameters": {},
+ "mode": "Incremental"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Succeeded",
+ "timestamp": "2020-06-05T01:51:58.6288067Z",
+ "duration": "PT1.2637681S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [],
+ "dependencies": [],
+ "outputResources": []
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "location": "eastus",
+ "properties": {
+ "templateLink": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
+ "contentVersion": "1.0.0.0"
+ },
+ "templateHash": "0000000000000000000",
+ "parameters": {},
+ "mode": "Incremental",
+ "provisioningState": "Accepted",
+ "timestamp": "2020-06-05T01:51:58.6288067Z",
+ "duration": "PT1.2637681S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [],
+ "dependencies": []
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
new file mode 100644
index 000000000000..25b06868ca06
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
@@ -0,0 +1,168 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "onErrorDeployment": {
+ "type": "LastSuccessful"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "LastSuccessful",
+ "deploymentName": "{nameOfLastSuccesfulDeployment}"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "LastSuccessful",
+ "deploymentName": "{nameOfLastSuccesfulDeployment}"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
new file mode 100644
index 000000000000..be56b7a76487
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
@@ -0,0 +1,169 @@
+{
+ "parameters": {
+ "subscriptionId": "00000000-0000-0000-0000-000000000000",
+ "resourceGroupName": "my-resource-group",
+ "deploymentName": "my-deployment",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ },
+ "201": {
+ "body": {
+ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
+ "name": "my-deployment",
+ "type": "Microsoft.Resources/deployments",
+ "properties": {
+ "templateLink": {
+ "uri": "https://example.com/exampleTemplate.json",
+ "contentVersion": "1.0.0.0"
+ },
+ "parameters": {},
+ "mode": "Complete",
+ "provisioningState": "Accepted",
+ "timestamp": "2019-03-01T00:00:00.0000000Z",
+ "duration": "PT0.8204881S",
+ "correlationId": "00000000-0000-0000-0000-000000000000",
+ "providers": [
+ {
+ "namespace": "Microsoft.Network",
+ "resourceTypes": [
+ {
+ "resourceType": "virtualNetworks",
+ "locations": [
+ "centralus"
+ ]
+ },
+ {
+ "resourceType": "virtualNetworks/subnets",
+ "locations": [
+ "centralus"
+ ]
+ }
+ ]
+ }
+ ],
+ "dependencies": [
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ },
+ {
+ "dependsOn": [
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks",
+ "resourceName": "VNet1"
+ },
+ {
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet1"
+ }
+ ],
+ "id": "{resourceid}",
+ "resourceType": "Microsoft.Network/virtualNetworks/subnets",
+ "resourceName": "VNet1/Subnet2"
+ }
+ ],
+ "onErrorDeployment": {
+ "type": "SpecificDeployment",
+ "deploymentName": "name-of-deployment-to-use"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
new file mode 100644
index 000000000000..ea6697821841
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
new file mode 100644
index 000000000000..78a72c3d436c
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
@@ -0,0 +1,26 @@
+{
+ "parameters": {
+ "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
+ "api-version": "2022-12-01",
+ "parameters": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "properties": {
+ "tags": {
+ "tagKey1": "tag-value-1",
+ "tagKey2": "tag-value-2"
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
new file mode 100644
index 000000000000..2b1e32082928
--- /dev/null
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
@@ -0,0 +1,6446 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "ResourceManagementClient",
+ "version": "2021-01-01",
+ "description": "Provides operations for working with resources and resource groups."
+ },
+ "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.Resources/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Lists all of the available Microsoft.Resources REST API operations.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtScope",
+ "summary": "Deploys resources at a given scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at a given scope.": {
+ "$ref": "./examples/PutDeploymentAtScope.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtScope",
+ "description": "Get all the deployments at the given scope.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtTenantScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtTenantScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtTenantScope",
+ "summary": "Deploys resources at tenant scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at tenant scope.": {
+ "$ref": "./examples/PutDeploymentAtTenant.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtTenantScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtTenantScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtTenantScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtTenantScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at management group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnTenant.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtTenantScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtTenantScope",
+ "description": "Get all the deployments at the tenant scope.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtManagementGroupScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtManagementGroupScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtManagementGroupScope",
+ "summary": "Deploys resources at management group scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-examples": {
+ "Create deployment at management group scope.": {
+ "$ref": "./examples/PutDeploymentAtManagementGroup.json"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtManagementGroupScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtManagementGroupScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtManagementGroupScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtManagementGroupScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ScopedDeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at management group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtManagementGroupScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtManagementGroupScope",
+ "description": "Get all the deployments for a management group.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_DeleteAtSubscriptionScope",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistenceAtSubscriptionScope",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope",
+ "summary": "Deploys resources at subscription scope.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a deployment that will deploy a templateSpec with the given resourceId": {
+ "$ref": "./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_GetAtSubscriptionScope",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CancelAtSubscriptionScope",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ValidateAtSubscriptionScope",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIfAtSubscriptionScope",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeploymentWhatIf"
+ },
+ "description": "Parameters to What If."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at subscription scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnSubscription.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplateAtSubscriptionScope",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListAtSubscriptionScope",
+ "description": "Get all the deployments for a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": {
+ "delete": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Delete",
+ "summary": "Deletes a deployment from the deployment history.",
+ "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployment to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted - Returns this status until the asynchronous operation has completed."
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "head": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CheckExistence",
+ "description": "Checks whether the deployment exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployment to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CreateOrUpdate",
+ "summary": "Deploys resources to a resource group.",
+ "description": "You can provide the template and parameters directly in the request or link to JSON files.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Additional parameters supplied to the operation."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create a deployment that will redeploy the last successful deployment on failure": {
+ "$ref": "./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json"
+ },
+ "Create a deployment that will redeploy another deployment on failure": {
+ "$ref": "./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json"
+ },
+ "Create a deployment that will deploy a templateSpec with the given resourceId": {
+ "$ref": "./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json"
+ },
+ "Create a deployment that will deploy a template with a uri and queryString": {
+ "$ref": "./examples/PutDeploymentResourceGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Get",
+ "description": "Gets a deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment, including provisioning status.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExtended"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Cancel",
+ "summary": "Cancels a currently running template deployment.",
+ "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_Validate",
+ "x-ms-long-running-operation": true,
+ "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
+ },
+ "400": {
+ "description": "Returns the validation result.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentValidateResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_WhatIf",
+ "description": "Returns changes that will be made by the deployment if executed at the scope of the resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeploymentWhatIf"
+ },
+ "description": "Parameters to validate."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns What-If operation status",
+ "schema": {
+ "$ref": "#/definitions/WhatIfOperationResult"
+ }
+ },
+ "202": {
+ "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
+ "headers": {
+ "Location": {
+ "type": "string",
+ "description": "URL to get status of this long-running operation."
+ },
+ "Retry-After": {
+ "type": "string",
+ "description": "Number of seconds to wait before polling for status."
+ }
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Predict template changes at resource group scope": {
+ "$ref": "./examples/PostDeploymentWhatIfOnResourceGroup.json"
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-long-running-operation-options": {
+ "final-state-via": "location"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ExportTemplate",
+ "description": "Exports the template used for specified deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns the template.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentExportResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": {
+ "get": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_ListByResourceGroup",
+ "description": "Get all the deployments for a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group with the deployments to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to get. If null is passed, returns all deployments."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of deployments.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Unregister",
+ "description": "Unregisters a subscription from a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to unregister."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_RegisterAtManagementGroupScope",
+ "description": "Registers a management group with a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to register."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": {
+ "post": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Register",
+ "description": "Registers a subscription with a resource provider.",
+ "parameters": [
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider to register."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_List",
+ "description": "Gets all resource providers for a subscription.",
+ "parameters": [
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed returns all deployments."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource providers.",
+ "schema": {
+ "$ref": "#/definitions/ProviderListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
+ "Get providers.": {
+ "$ref": "./examples/GetProviders.json"
+ }
+ }
+ }
+ },
+ "/providers": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_ListAtTenantScope",
+ "description": "Gets all resource providers for the tenant.",
+ "parameters": [
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed returns all providers."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource providers.",
+ "schema": {
+ "$ref": "#/definitions/ProviderListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "Providers_Get",
+ "description": "Gets the specified resource provider.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get provider.": {
+ "$ref": "./examples/GetProvider.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "operationId": "ProviderResourceTypes_List",
+ "description": "List the resource types for a specified resource provider.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns resource types information for the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/ProviderResourceTypeListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get provider resource types.": {
+ "$ref": "./examples/GetProviderResourceTypes.json"
+ }
+ }
+ }
+ },
+ "/providers/{resourceProviderNamespace}": {
+ "get": {
+ "tags": [
+ "Providers"
+ ],
+ "x-ms-examples": {
+ "Get a resource provider at tenant scope": {
+ "$ref": "./examples/GetNamedProviderAtTenant.json"
+ }
+ },
+ "operationId": "Providers_GetAtTenantScope",
+ "description": "Gets the specified resource provider at the tenant level.",
+ "parameters": [
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource provider.",
+ "schema": {
+ "$ref": "#/definitions/Provider"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": {
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "Resources_ListByResourceGroup",
+ "description": "Get all the resources for a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource group with the resources to get.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": {
+ "head": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_CheckExistence",
+ "description": "Checks whether a resource group exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "x-ms-examples": {
+ "Create or update a resource group": {
+ "$ref": "./examples/CreateResourceGroup.json"
+ }
+ },
+ "operationId": "ResourceGroups_CreateOrUpdate",
+ "description": "Creates or updates a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "Parameters supplied to the create or update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the new resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Delete",
+ "summary": "Deletes a resource group.",
+ "description": "When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "forceDeletionTypes",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "x-ms-examples": {
+ "Force delete all the Virtual Machines in a resource group": {
+ "$ref": "./examples/ForceDeleteVMsInResourceGroup.json"
+ },
+ "Force delete all the Virtual Machines and Virtual Machine Scale Sets in a resource group": {
+ "$ref": "./examples/ForceDeleteVMsAndVMSSInResourceGroup.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Get",
+ "description": "Gets a resource group.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_Update",
+ "summary": "Updates a resource group.",
+ "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group to update. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupPatchable"
+ },
+ "description": "Parameters supplied to update a resource group."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource group.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroup"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": {
+ "post": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_ExportTemplate",
+ "description": "Captures the specified resource group as a template.",
+ "parameters": [
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
+ },
+ {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ExportTemplateRequest"
+ },
+ "description": "Parameters for exporting the template."
+ }
+ ],
+ "x-ms-examples": {
+ "Export a resource group": {
+ "$ref": "./examples/ExportResourceGroup.json"
+ },
+ "Export a resource group with filtering": {
+ "$ref": "./examples/ExportResourceGroupWithFiltering.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the result of the export.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupExportResult"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "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"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups": {
+ "get": {
+ "tags": [
+ "ResourceGroups"
+ ],
+ "operationId": "ResourceGroups_List",
+ "description": "Gets all the resource groups for a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resource groups."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resource groups.",
+ "schema": {
+ "$ref": "#/definitions/ResourceGroupListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/ResourceGroupFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_MoveResources",
+ "summary": "Moves resources from one resource group to another resource group.",
+ "description": "The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources": {
+ "post": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_ValidateMoveResources",
+ "summary": "Validates whether resources can be moved from one resource group to another resource group.",
+ "description": "This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.",
+ "parameters": [
+ {
+ "name": "sourceResourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resources to validate for move.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourcesMoveInfo"
+ },
+ "description": "Parameters for moving resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resources": {
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_List",
+ "description": "Get all the resources in a subscription.",
+ "parameters": [
+ {
+ "name": "$filter",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
+ },
+ {
+ "name": "$expand",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return. If null is passed, returns all resources."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of resources.",
+ "schema": {
+ "$ref": "#/definitions/ResourceListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "x-ms-odata": "#/definitions/GenericResourceFilter"
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistence",
+ "description": "Checks whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to check. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource provider of the resource to check."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to check whether it exists."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Delete",
+ "description": "Deletes a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group that contains the resource to delete. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to delete."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdate",
+ "description": "Creates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to create.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to create."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for creating or updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Update",
+ "description": "Updates a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group for the resource. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource to update.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to update."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Parameters for updating the resource."
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_Get",
+ "description": "Gets a resource.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group containing the resource to get. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "name": "resourceProviderNamespace",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ {
+ "name": "parentResourcePath",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The parent resource identity.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceType",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource type of the resource.",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource to get."
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{resourceId}": {
+ "head": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CheckExistenceById",
+ "description": "Checks by ID whether a resource exists.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_DeleteById",
+ "description": "Deletes a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "put": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_CreateOrUpdateById",
+ "description": "Create a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Create or update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "201": {
+ "description": "Created - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_UpdateById",
+ "description": "Updates a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ },
+ "description": "Update resource parameters."
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "get": {
+ "tags": [
+ "Resources"
+ ],
+ "operationId": "Resources_GetById",
+ "description": "Gets a resource by ID.",
+ "parameters": [
+ {
+ "name": "resourceId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-api-version": false
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the resource.",
+ "schema": {
+ "$ref": "#/definitions/GenericResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": {
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_DeleteValue",
+ "summary": "Deletes a predefined tag value for a predefined tag name.",
+ "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to delete."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag value did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdateValue",
+ "summary": "Creates a predefined value for a predefined tag name.",
+ "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "name": "tagValue",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The value of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag value already exists. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "201": {
+ "description": "Predefined tag value successfully created. Returns information about the predefined tag value.",
+ "schema": {
+ "$ref": "#/definitions/TagValue"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames/{tagName}": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdate",
+ "summary": "Creates a predefined tag name.",
+ "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag to create."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name already exists. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "201": {
+ "description": "Predefined tag name successfully created. Returns information about the predefined tag name.",
+ "schema": {
+ "$ref": "#/definitions/TagDetails"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_Delete",
+ "summary": "Deletes a predefined tag name.",
+ "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.",
+ "parameters": [
+ {
+ "name": "tagName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the tag."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Predefined tag name successfully deleted."
+ },
+ "204": {
+ "description": "Predefined tag name did not exist."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/tagNames": {
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_List",
+ "summary": "Gets a summary of tag usage under the subscription.",
+ "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns an array of tag names and values.",
+ "schema": {
+ "$ref": "#/definitions/TagsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtTenantScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtTenantScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtManagementGroupScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtManagementGroupScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/GroupIdParameter"
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_GetAtSubscriptionScope",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_ListAtSubscriptionScope",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_Get",
+ "description": "Gets a deployments operation.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the operation to get."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Returns information about the deployment operation.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperation"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": {
+ "get": {
+ "tags": [
+ "DeploymentOperations"
+ ],
+ "operationId": "DeploymentOperations_List",
+ "description": "Gets all deployments operations for a deployment.",
+ "parameters": [
+ {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group. The name is case insensitive.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ {
+ "$ref": "#/parameters/DeploymentNameParameter"
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "required": false,
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of results to return."
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK - Return an array of deployment operations.",
+ "schema": {
+ "$ref": "#/definitions/DeploymentOperationsListResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Resources/calculateTemplateHash": {
+ "post": {
+ "tags": [
+ "Deployments"
+ ],
+ "operationId": "Deployments_CalculateTemplateHash",
+ "description": "Calculate the hash of the given template.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "template",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "type": "object"
+ },
+ "description": "The template provided to calculate hash."
+ }
+ ],
+ "x-ms-examples": {
+ "Calculate template hash": {
+ "$ref": "./examples/CalculateTemplateHash.json"
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK - Returns the hash.",
+ "schema": {
+ "$ref": "#/definitions/TemplateHashResult"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ },
+ "/{scope}/providers/Microsoft.Resources/tags/default": {
+ "put": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_CreateOrUpdateAtScope",
+ "summary": "Creates or updates the entire set of tags on a resource or subscription.",
+ "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update tags on a resource": {
+ "$ref": "./examples/PutTagsResource.json"
+ },
+ "Update tags on a subscription": {
+ "$ref": "./examples/PutTagsSubscription.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_UpdateAtScope",
+ "summary": "Selectively updates the set of tags on a resource or subscription.",
+ "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "name": "parameters",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TagsPatchResource"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags updated successfully. Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_GetAtScope",
+ "summary": "Gets the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Returns tags from the specified object.",
+ "schema": {
+ "$ref": "#/definitions/TagsResource"
+ }
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get tags on a resource": {
+ "$ref": "./examples/GetTagsResource.json"
+ },
+ "Get tags on a subscription": {
+ "$ref": "./examples/GetTagsSubscription.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Tags"
+ ],
+ "operationId": "Tags_DeleteAtScope",
+ "summary": "Deletes the entire set of tags on a resource or subscription.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ScopeParameter"
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Tags successfully deleted."
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DeploymentExtendedFilter": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "description": "The provisioning state."
+ }
+ },
+ "description": "Deployment filter."
+ },
+ "GenericResourceFilter": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "tagname": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagvalue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource filter."
+ },
+ "ResourceGroupFilter": {
+ "properties": {
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ },
+ "description": "Resource group filter."
+ },
+ "TemplateLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the template to deploy. Use either the uri or id property, but not both."
+ },
+ "id": {
+ "type": "string",
+ "description": "The resource id of a Template Spec. Use either the id or uri property, but not both."
+ },
+ "relativePath": {
+ "type": "string",
+ "description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs"
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ },
+ "queryString": {
+ "type": "string",
+ "description": "The query string (for example, a SAS token) to be used with the templateLink URI."
+ }
+ },
+ "description": "Entity representing the reference to the template."
+ },
+ "ParametersLink": {
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The URI of the parameters file."
+ },
+ "contentVersion": {
+ "type": "string",
+ "description": "If included, must match the ContentVersion in the template."
+ }
+ },
+ "required": [
+ "uri"
+ ],
+ "description": "Entity representing the reference to the deployment parameters."
+ },
+ "DeploymentProperties": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both."
+ },
+ "templateLink": {
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI of the template. Use either the templateLink property or the template property, but not both."
+ },
+ "parameters": {
+ "type": "object",
+ "description": "Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string."
+ },
+ "parametersLink": {
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both."
+ },
+ "mode": {
+ "type": "string",
+ "description": "The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "$ref": "#/definitions/OnErrorDeployment",
+ "description": "The deployment on error behavior."
+ },
+ "expressionEvaluationOptions": {
+ "$ref": "#/definitions/ExpressionEvaluationOptions",
+ "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer."
+ }
+ },
+ "required": [
+ "mode"
+ ],
+ "description": "Deployment properties."
+ },
+ "DebugSetting": {
+ "properties": {
+ "detailLevel": {
+ "type": "string",
+ "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations."
+ }
+ },
+ "description": "The debug setting."
+ },
+ "Deployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "ScopedDeployment": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentProperties",
+ "description": "The deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "description": "Deployment operation parameters."
+ },
+ "DeploymentExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ }
+ },
+ "description": "The deployment export result. "
+ },
+ "DeploymentWhatIf": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentWhatIfProperties",
+ "description": "The deployment properties."
+ }
+ },
+ "required": [
+ "properties"
+ ],
+ "description": "Deployment What-if operation parameters."
+ },
+ "ScopedDeploymentWhatIf": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location to store the deployment data."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentWhatIfProperties",
+ "description": "The deployment properties."
+ }
+ },
+ "required": [
+ "location",
+ "properties"
+ ],
+ "description": "Deployment What-if operation parameters."
+ },
+ "DeploymentWhatIfProperties": {
+ "properties": {
+ "whatIfSettings": {
+ "$ref": "#/definitions/DeploymentWhatIfSettings",
+ "description": "Optional What-If operation settings."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/DeploymentProperties"
+ }
+ ],
+ "description": "Deployment What-if properties."
+ },
+ "DeploymentWhatIfSettings": {
+ "properties": {
+ "resultFormat": {
+ "type": "string",
+ "description": "The format of the What-If results",
+ "enum": [
+ "ResourceIdOnly",
+ "FullResourcePayloads"
+ ],
+ "x-ms-enum": {
+ "name": "WhatIfResultFormat",
+ "modelAsString": false
+ }
+ }
+ },
+ "description": "Deployment What-If operation settings."
+ },
+ "CloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
+ }
+ },
+ "description": "An error response for a resource management request."
+ },
+ "ApiProfile": {
+ "properties": {
+ "profileVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The profile version."
+ },
+ "apiVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The API version."
+ }
+ }
+ },
+ "AliasPathMetadata": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "NotSpecified",
+ "Any",
+ "String",
+ "Object",
+ "Array",
+ "Integer",
+ "Number",
+ "Boolean"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPathTokenType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "The token type is not specified."
+ },
+ {
+ "value": "Any",
+ "description": "The token type can be anything."
+ },
+ {
+ "value": "String",
+ "description": "The token type is string."
+ },
+ {
+ "value": "Object",
+ "description": "The token type is object."
+ },
+ {
+ "value": "Array",
+ "description": "The token type is array."
+ },
+ {
+ "value": "Integer",
+ "description": "The token type is integer."
+ },
+ {
+ "value": "Number",
+ "description": "The token type is number."
+ },
+ {
+ "value": "Boolean",
+ "description": "The token type is boolean."
+ }
+ ]
+ },
+ "description": "The type of the token that the alias path is referring to."
+ },
+ "attributes": {
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "None",
+ "Modifiable"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPathAttributes",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "None",
+ "description": "The token that the alias path is referring to has no attributes."
+ },
+ {
+ "value": "Modifiable",
+ "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
+ }
+ ]
+ },
+ "description": "The attributes of the token that the alias path is referring to."
+ }
+ }
+ },
+ "AliasPath": {
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of an alias."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API versions."
+ },
+ "pattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The pattern for an alias path."
+ },
+ "metadata": {
+ "readOnly": true,
+ "$ref": "#/definitions/AliasPathMetadata",
+ "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias."
+ }
+ },
+ "description": "The type of the paths for alias."
+ },
+ "AliasPattern": {
+ "properties": {
+ "phrase": {
+ "type": "string",
+ "description": "The alias pattern phrase."
+ },
+ "variable": {
+ "type": "string",
+ "description": "The alias pattern variable."
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "NotSpecified",
+ "Extract"
+ ],
+ "x-ms-enum": {
+ "name": "AliasPatternType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "NotSpecified is not allowed."
+ },
+ {
+ "value": "Extract",
+ "description": "Extract is the only allowed value."
+ }
+ ]
+ },
+ "description": "The type of alias pattern"
+ }
+ },
+ "description": "The type of the pattern for an alias path."
+ },
+ "Alias": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The alias name."
+ },
+ "paths": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AliasPath"
+ },
+ "description": "The paths for an alias."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of the alias.",
+ "enum": [
+ "NotSpecified",
+ "PlainText",
+ "Mask"
+ ],
+ "x-ms-enum": {
+ "name": "AliasType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "Alias type is unknown (same as not providing alias type)."
+ },
+ {
+ "value": "PlainText",
+ "description": "Alias value is not secret."
+ },
+ {
+ "value": "Mask",
+ "description": "Alias value is secret."
+ }
+ ]
+ }
+ },
+ "defaultPath": {
+ "type": "string",
+ "description": "The default path for an alias."
+ },
+ "defaultPattern": {
+ "$ref": "#/definitions/AliasPattern",
+ "description": "The default pattern for an alias."
+ },
+ "defaultMetadata": {
+ "readOnly": true,
+ "$ref": "#/definitions/AliasPathMetadata",
+ "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata"
+ }
+ },
+ "description": "The alias type. "
+ },
+ "ProviderExtendedLocation": {
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The azure location."
+ },
+ "type": {
+ "type": "string",
+ "description": "The extended location type."
+ },
+ "extendedLocations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The extended locations for the azure location."
+ }
+ },
+ "description": "The provider extended location. "
+ },
+ "ProviderResourceType": {
+ "properties": {
+ "resourceType": {
+ "type": "string",
+ "description": "The resource type."
+ },
+ "locations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The collection of locations where this resource type can be created."
+ },
+ "locationMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderExtendedLocation"
+ },
+ "description": "The location mappings that are supported by this resource type."
+ },
+ "aliases": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Alias"
+ },
+ "description": "The aliases that are supported by this resource type."
+ },
+ "apiVersions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The API version."
+ },
+ "defaultApiVersion": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The default API version."
+ },
+ "zoneMappings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ZoneMapping"
+ }
+ },
+ "apiProfiles": {
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/ApiProfile"
+ },
+ "description": "The API profiles for the resource provider."
+ },
+ "capabilities": {
+ "type": "string",
+ "description": "The additional capabilities offered by this resource type."
+ },
+ "properties": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The properties."
+ }
+ },
+ "description": "Resource type managed by the resource provider."
+ },
+ "Provider": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provider ID."
+ },
+ "namespace": {
+ "type": "string",
+ "description": "The namespace of the resource provider."
+ },
+ "registrationState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration state of the resource provider."
+ },
+ "registrationPolicy": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The registration policy of the resource provider."
+ },
+ "resourceTypes": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderResourceType"
+ },
+ "description": "The collection of provider resource types."
+ }
+ },
+ "description": "Resource provider information."
+ },
+ "BasicDependency": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "Dependency": {
+ "properties": {
+ "dependsOn": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BasicDependency"
+ },
+ "description": "The list of dependencies."
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the dependency."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The dependency resource type."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The dependency resource name."
+ }
+ },
+ "description": "Deployment dependency information."
+ },
+ "DeploymentPropertiesExtended": {
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Denotes the state of provisioning.",
+ "enum": [
+ "NotSpecified",
+ "Accepted",
+ "Running",
+ "Ready",
+ "Creating",
+ "Created",
+ "Deleting",
+ "Deleted",
+ "Canceled",
+ "Failed",
+ "Succeeded",
+ "Updating"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": true
+ }
+ },
+ "correlationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The correlation ID of the deployment."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The timestamp of the template deployment."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the template deployment."
+ },
+ "outputs": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Key/value pairs that represent deployment output."
+ },
+ "providers": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "The list of resource providers needed for the deployment."
+ },
+ "dependencies": {
+ "readOnly": true,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Dependency"
+ },
+ "description": "The list of deployment dependencies."
+ },
+ "templateLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/TemplateLink",
+ "description": "The URI referencing the template."
+ },
+ "parameters": {
+ "readOnly": true,
+ "type": "object",
+ "description": "Deployment parameters. "
+ },
+ "parametersLink": {
+ "readOnly": true,
+ "$ref": "#/definitions/ParametersLink",
+ "description": "The URI referencing the parameters. "
+ },
+ "mode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The deployment mode. Possible values are Incremental and Complete.",
+ "enum": [
+ "Incremental",
+ "Complete"
+ ],
+ "x-ms-enum": {
+ "name": "DeploymentMode",
+ "modelAsString": false
+ }
+ },
+ "debugSetting": {
+ "readOnly": true,
+ "$ref": "#/definitions/DebugSetting",
+ "description": "The debug setting of the deployment."
+ },
+ "onErrorDeployment": {
+ "readOnly": true,
+ "$ref": "#/definitions/OnErrorDeploymentExtended",
+ "description": "The deployment on error behavior."
+ },
+ "templateHash": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The hash produced for the template."
+ },
+ "outputResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of provisioned resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of provisioned resources."
+ }
+ },
+ "validatedResources": {
+ "readOnly": true,
+ "type": "array",
+ "description": "Array of validated resources.",
+ "items": {
+ "$ref": "#/definitions/ResourceReference",
+ "description": "Details of validated resources."
+ }
+ },
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment error."
+ }
+ },
+ "description": "Deployment properties with additional details."
+ },
+ "ResourceReference": {
+ "description": "The resource Id model.",
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The fully qualified resource Id."
+ }
+ }
+ },
+ "OnErrorDeployment": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior."
+ },
+ "OnErrorDeploymentExtended": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning for the on error deployment."
+ },
+ "type": {
+ "type": "string",
+ "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
+ "enum": [
+ "LastSuccessful",
+ "SpecificDeployment"
+ ],
+ "x-ms-enum": {
+ "name": "OnErrorDeploymentType",
+ "modelAsString": false
+ }
+ },
+ "deploymentName": {
+ "type": "string",
+ "description": "The deployment to be used on error case."
+ }
+ },
+ "description": "Deployment on error behavior with additional details."
+ },
+ "DeploymentValidateResult": {
+ "properties": {
+ "error": {
+ "readOnly": true,
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The deployment validation error."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "The template deployment properties."
+ }
+ },
+ "description": "Information from validate template deployment response."
+ },
+ "DeploymentExtended": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the deployment."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the deployment."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the deployment."
+ },
+ "location": {
+ "type": "string",
+ "description": "the location of the deployment."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentPropertiesExtended",
+ "description": "Deployment properties."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Deployment tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Deployment information."
+ },
+ "DeploymentListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentExtended"
+ },
+ "description": "An array of deployments."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployments."
+ },
+ "ProviderListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Provider"
+ },
+ "description": "An array of resource providers."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource providers."
+ },
+ "ProviderResourceTypeListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProviderResourceType"
+ },
+ "description": "An array of resource types."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource types of a resource provider."
+ },
+ "GenericResource": {
+ "properties": {
+ "plan": {
+ "$ref": "#/definitions/Plan",
+ "description": "The plan of the resource."
+ },
+ "properties": {
+ "type": "object",
+ "description": "The resource properties."
+ },
+ "kind": {
+ "type": "string",
+ "description": "The kind of the resource.",
+ "pattern": "^[-\\w\\._,\\(\\)]+$"
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "ID of the resource that manages this resource."
+ },
+ "sku": {
+ "$ref": "#/definitions/Sku",
+ "description": "The SKU of the resource."
+ },
+ "identity": {
+ "$ref": "#/definitions/Identity",
+ "description": "The identity of the resource."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "ExtendedLocation": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "EdgeZone"
+ ],
+ "x-ms-enum": {
+ "name": "ExtendedLocationType",
+ "modelAsString": true
+ },
+ "description": "The extended location type."
+ },
+ "name": {
+ "type": "string",
+ "description": "The extended location name."
+ }
+ },
+ "description": "Resource extended location."
+ },
+ "GenericResourceExpanded": {
+ "properties": {
+ "createdTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The created time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "changedTime": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
+ }
+ },
+ "allOf": [
+ {
+ "$ref": "#/definitions/GenericResource"
+ }
+ ],
+ "description": "Resource information."
+ },
+ "Plan": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The plan ID."
+ },
+ "publisher": {
+ "type": "string",
+ "description": "The publisher ID."
+ },
+ "product": {
+ "type": "string",
+ "description": "The offer ID."
+ },
+ "promotionCode": {
+ "type": "string",
+ "description": "The promotion code."
+ },
+ "version": {
+ "type": "string",
+ "description": "The plan's version."
+ }
+ },
+ "description": "Plan for the resource."
+ },
+ "Sku": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The SKU name."
+ },
+ "tier": {
+ "type": "string",
+ "description": "The SKU tier."
+ },
+ "size": {
+ "type": "string",
+ "description": "The SKU size."
+ },
+ "family": {
+ "type": "string",
+ "description": "The SKU family."
+ },
+ "model": {
+ "type": "string",
+ "description": "The SKU model."
+ },
+ "capacity": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The SKU capacity."
+ }
+ },
+ "description": "SKU for the resource."
+ },
+ "Identity": {
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal ID of resource identity."
+ },
+ "tenantId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tenant ID of resource."
+ },
+ "type": {
+ "type": "string",
+ "description": "The identity type.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "x-ms-enum": {
+ "name": "ResourceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "userAssignedIdentities": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "x-ms-client-name": "IdentityUserAssignedIdentitiesValue",
+ "properties": {
+ "principalId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The principal id of user assigned identity."
+ },
+ "clientId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The client id of user assigned identity."
+ }
+ }
+ },
+ "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
+ }
+ },
+ "description": "Identity for the resource."
+ },
+ "ResourceListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GenericResourceExpanded"
+ },
+ "description": "An array of resources."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourceGroup": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the resource group."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "location": {
+ "type": "string",
+ "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "required": [
+ "location"
+ ],
+ "x-ms-azure-resource": true,
+ "description": "Resource group information."
+ },
+ "ResourceGroupPatchable": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name of the resource group."
+ },
+ "properties": {
+ "$ref": "#/definitions/ResourceGroupProperties",
+ "description": "The resource group properties."
+ },
+ "managedBy": {
+ "type": "string",
+ "description": "The ID of the resource that manages this resource group."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The additional properties. "
+ },
+ "description": "The tags attached to the resource group."
+ }
+ },
+ "description": "Resource group information."
+ },
+ "ResourceGroupProperties": {
+ "properties": {
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The provisioning state. "
+ }
+ },
+ "description": "The resource group properties."
+ },
+ "ResourceGroupListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceGroup"
+ },
+ "description": "An array of resource groups."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of resource groups."
+ },
+ "ResourcesMoveInfo": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources."
+ },
+ "targetResourceGroup": {
+ "type": "string",
+ "description": "The target resource group."
+ }
+ },
+ "description": "Parameters of move resources."
+ },
+ "ExportTemplateRequest": {
+ "properties": {
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'."
+ },
+ "options": {
+ "type": "string",
+ "description": "The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'"
+ }
+ },
+ "description": "Export resource group template request parameters."
+ },
+ "TagCount": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of count."
+ },
+ "value": {
+ "type": "integer",
+ "description": "Value of count."
+ }
+ },
+ "description": "Tag count."
+ },
+ "TagValue": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag value ID."
+ },
+ "tagValue": {
+ "type": "string",
+ "description": "The tag value."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The tag value count."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag information."
+ },
+ "TagDetails": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The tag name ID."
+ },
+ "tagName": {
+ "type": "string",
+ "description": "The tag name."
+ },
+ "count": {
+ "$ref": "#/definitions/TagCount",
+ "description": "The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0."
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagValue"
+ },
+ "description": "The list of tag values."
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Tag details."
+ },
+ "TagsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TagDetails"
+ },
+ "description": "An array of tags."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of subscription tags."
+ },
+ "TargetResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the resource."
+ },
+ "resourceName": {
+ "type": "string",
+ "description": "The name of the resource."
+ },
+ "resourceType": {
+ "type": "string",
+ "description": "The type of the resource."
+ }
+ },
+ "description": "Target resource."
+ },
+ "HttpMessage": {
+ "properties": {
+ "content": {
+ "type": "object",
+ "description": "HTTP message content."
+ }
+ },
+ "description": "HTTP message."
+ },
+ "DeploymentOperationProperties": {
+ "properties": {
+ "provisioningOperation": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the current provisioning operation.",
+ "enum": [
+ "NotSpecified",
+ "Create",
+ "Delete",
+ "Waiting",
+ "AzureAsyncOperationWaiting",
+ "ResourceCacheWaiting",
+ "Action",
+ "Read",
+ "EvaluateDeploymentOutput",
+ "DeploymentCleanup"
+ ],
+ "x-ms-enum": {
+ "name": "ProvisioningOperation",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "NotSpecified",
+ "description": "The provisioning operation is not specified."
+ },
+ {
+ "value": "Create",
+ "description": "The provisioning operation is create."
+ },
+ {
+ "value": "Delete",
+ "description": "The provisioning operation is delete."
+ },
+ {
+ "value": "Waiting",
+ "description": "The provisioning operation is waiting."
+ },
+ {
+ "value": "AzureAsyncOperationWaiting",
+ "description": "The provisioning operation is waiting Azure async operation."
+ },
+ {
+ "value": "ResourceCacheWaiting",
+ "description": "The provisioning operation is waiting for resource cache."
+ },
+ {
+ "value": "Action",
+ "description": "The provisioning operation is action."
+ },
+ {
+ "value": "Read",
+ "description": "The provisioning operation is read."
+ },
+ {
+ "value": "EvaluateDeploymentOutput",
+ "description": "The provisioning operation is evaluate output."
+ },
+ {
+ "value": "DeploymentCleanup",
+ "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment."
+ }
+ ]
+ }
+ },
+ "provisioningState": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The state of the provisioning."
+ },
+ "timestamp": {
+ "readOnly": true,
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time of the operation."
+ },
+ "duration": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The duration of the operation."
+ },
+ "serviceRequestId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation service request id."
+ },
+ "statusCode": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Operation status code from the resource provider. This property may not be set if a response has not yet been received."
+ },
+ "statusMessage": {
+ "readOnly": true,
+ "description": "Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider.",
+ "$ref": "#/definitions/StatusMessage"
+ },
+ "targetResource": {
+ "readOnly": true,
+ "$ref": "#/definitions/TargetResource",
+ "description": "The target resource."
+ },
+ "request": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP request message."
+ },
+ "response": {
+ "readOnly": true,
+ "$ref": "#/definitions/HttpMessage",
+ "description": "The HTTP response message."
+ }
+ },
+ "description": "Deployment operation properties."
+ },
+ "DeploymentOperation": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Full deployment operation ID."
+ },
+ "operationId": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Deployment operation ID."
+ },
+ "properties": {
+ "$ref": "#/definitions/DeploymentOperationProperties",
+ "description": "Deployment properties."
+ }
+ },
+ "description": "Deployment operation information."
+ },
+ "DeploymentOperationsListResult": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DeploymentOperation"
+ },
+ "description": "An array of deployment operations."
+ },
+ "nextLink": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The URL to use for getting the next set of results."
+ }
+ },
+ "description": "List of deployment operations."
+ },
+ "ResourceProviderOperationDisplayProperties": {
+ "properties": {
+ "publisher": {
+ "type": "string",
+ "description": "Operation description."
+ },
+ "provider": {
+ "type": "string",
+ "description": "Operation provider."
+ },
+ "resource": {
+ "type": "string",
+ "description": "Operation resource."
+ },
+ "operation": {
+ "type": "string",
+ "description": "Resource provider operation."
+ },
+ "description": {
+ "type": "string",
+ "description": "Operation description."
+ }
+ },
+ "description": "Resource provider operation's display properties."
+ },
+ "Resource": {
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource name"
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "Resource type"
+ },
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "extendedLocation": {
+ "$ref": "#/definitions/ExtendedLocation",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ],
+ "description": "Resource extended location."
+ },
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Resource tags"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Specified resource."
+ },
+ "SubResource": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "Resource ID"
+ }
+ },
+ "x-ms-azure-resource": true,
+ "description": "Sub-resource."
+ },
+ "ResourceGroupExportResult": {
+ "properties": {
+ "template": {
+ "type": "object",
+ "description": "The template content."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The template export error."
+ }
+ },
+ "description": "Resource group export result."
+ },
+ "Operation": {
+ "description": "Microsoft.Resources operation",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
+ },
+ "display": {
+ "description": "The object that represents the operation.",
+ "properties": {
+ "provider": {
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the operation.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "OperationListResult": {
+ "description": "Result of the request to list Microsoft.Resources 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.Resources operations."
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results if there are any."
+ }
+ }
+ },
+ "TemplateHashResult": {
+ "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.",
+ "properties": {
+ "minifiedTemplate": {
+ "type": "string",
+ "description": "The minified template string."
+ },
+ "templateHash": {
+ "type": "string",
+ "description": "The template hash."
+ }
+ }
+ },
+ "WhatIfPropertyChange": {
+ "required": [
+ "path",
+ "propertyChangeType"
+ ],
+ "properties": {
+ "path": {
+ "type": "string",
+ "description": "The path of the property."
+ },
+ "propertyChangeType": {
+ "type": "string",
+ "description": "The type of property change.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Modify",
+ "Array",
+ "NoEffect"
+ ],
+ "x-ms-enum": {
+ "name": "PropertyChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Modify",
+ "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed."
+ },
+ {
+ "value": "Array",
+ "description": "The property is an array and contains nested changes."
+ },
+ {
+ "value": "NoEffect",
+ "description": "The property will not be set or updated."
+ }
+ ]
+ }
+ },
+ "before": {
+ "type": "object",
+ "description": "The value of the property before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The value of the property after the deployment is executed."
+ },
+ "children": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "Nested property changes."
+ }
+ },
+ "description": "The predicted change to the resource property."
+ },
+ "WhatIfChange": {
+ "description": "Information about a single resource change predicted by What-If operation.",
+ "required": [
+ "resourceId",
+ "changeType"
+ ],
+ "properties": {
+ "resourceId": {
+ "type": "string",
+ "description": "Resource ID"
+ },
+ "changeType": {
+ "type": "string",
+ "description": "Type of change that will be made to the resource when the deployment is executed.",
+ "enum": [
+ "Create",
+ "Delete",
+ "Ignore",
+ "Deploy",
+ "NoChange",
+ "Modify",
+ "Unsupported"
+ ],
+ "x-ms-enum": {
+ "name": "ChangeType",
+ "modelAsString": false,
+ "values": [
+ {
+ "value": "Create",
+ "description": "The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed."
+ },
+ {
+ "value": "Delete",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed."
+ },
+ {
+ "value": "Ignore",
+ "description": "The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed."
+ },
+ {
+ "value": "Deploy",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change."
+ },
+ {
+ "value": "NoChange",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change."
+ },
+ {
+ "value": "Modify",
+ "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change."
+ },
+ {
+ "value": "Unsupported",
+ "description": "The resource is not supported by What-If."
+ }
+ ]
+ }
+ },
+ "unsupportedReason": {
+ "type": "string",
+ "description": "The explanation about why the resource is unsupported by What-If."
+ },
+ "before": {
+ "type": "object",
+ "description": "The snapshot of the resource before the deployment is executed."
+ },
+ "after": {
+ "type": "object",
+ "description": "The predicted snapshot of the resource after the deployment is executed."
+ },
+ "delta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfPropertyChange"
+ },
+ "description": "The predicted changes to resource properties."
+ }
+ }
+ },
+ "WhatIfOperationProperties": {
+ "description": "Deployment operation properties.",
+ "properties": {
+ "changes": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WhatIfChange"
+ },
+ "description": "List of resource changes predicted by What-If operation."
+ }
+ }
+ },
+ "WhatIfOperationResult": {
+ "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the What-If operation."
+ },
+ "properties": {
+ "x-ms-client-flatten": true,
+ "$ref": "#/definitions/WhatIfOperationProperties",
+ "description": "What-If operation properties."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "Error when What-If operation fails."
+ }
+ }
+ },
+ "Tags": {
+ "description": "A dictionary of name and value pairs.",
+ "properties": {
+ "tags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "description": "The tag value."
+ }
+ }
+ }
+ },
+ "TagsPatchResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags patch API request only.",
+ "properties": {
+ "operation": {
+ "type": "string",
+ "description": "The operation type for the patch API.",
+ "enum": [
+ "Replace",
+ "Merge",
+ "Delete"
+ ],
+ "x-ms-enum": {
+ "name": "tagsPatchOperation",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Replace",
+ "description": "The 'replace' option replaces the entire set of existing tags with a new set."
+ },
+ {
+ "value": "Merge",
+ "description": "The 'merge' option allows adding tags with new names and updating the values of tags with existing names."
+ },
+ {
+ "value": "Delete",
+ "description": "The 'delete' option allows selectively deleting tags based on given names or name/value pairs."
+ }
+ ]
+ }
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ }
+ },
+ "TagsResource": {
+ "type": "object",
+ "description": "Wrapper resource for tags API requests and responses.",
+ "required": [
+ "properties"
+ ],
+ "properties": {
+ "id": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The ID of the tags wrapper resource."
+ },
+ "name": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The name of the tags wrapper resource."
+ },
+ "type": {
+ "readOnly": true,
+ "type": "string",
+ "description": "The type of the tags wrapper resource."
+ },
+ "properties": {
+ "$ref": "#/definitions/Tags",
+ "description": "The set of tags."
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "StatusMessage": {
+ "type": "object",
+ "description": "Operation status message object.",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "Status of the deployment operation."
+ },
+ "error": {
+ "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
+ "description": "The error reported by the operation."
+ }
+ }
+ },
+ "ExpressionEvaluationOptions": {
+ "properties": {
+ "scope": {
+ "type": "string",
+ "description": "The scope to be used for evaluation of parameters, variables and functions in a nested template.",
+ "enum": [
+ "NotSpecified",
+ "Outer",
+ "Inner"
+ ],
+ "x-ms-enum": {
+ "name": "ExpressionEvaluationOptionsScopeType",
+ "modelAsString": true
+ }
+ }
+ },
+ "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template."
+ },
+ "ZoneMapping": {
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "The location of the zone mapping."
+ },
+ "zones": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "ScopeParameter": {
+ "name": "scope",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The resource scope.",
+ "x-ms-parameter-location": "method",
+ "x-ms-skip-url-encoding": true
+ },
+ "GroupIdParameter": {
+ "name": "groupId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The management group ID.",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 90
+ },
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription."
+ },
+ "DeploymentNameParameter": {
+ "name": "deploymentName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "x-ms-parameter-location": "method",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the deployment."
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for this operation."
+ }
+ }
+}
From 0666ae7b6929e24b4f769340cec51111bb0d42bc Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 10:52:50 -0700
Subject: [PATCH 13/37] Deleting files
---
.../examples/CalculateTemplateHash.json | 46 -
.../examples/CreateResourceGroup.json | 32 -
.../examples/ExportResourceGroup.json | 68 -
.../ExportResourceGroupWithFiltering.json | 46 -
.../ForceDeleteVMsAndVMSSInResourceGroup.json | 16 -
.../ForceDeleteVMsInResourceGroup.json | 16 -
.../examples/GetNamedProviderAtTenant.json | 253 -
.../2022-12-01/examples/GetProvider.json | 51 -
.../examples/GetProviderResourceTypes.json | 47 -
.../2022-12-01/examples/GetProviders.json | 175 -
.../2022-12-01/examples/GetTagsResource.json | 18 -
.../examples/GetTagsSubscription.json | 18 -
...PostDeploymentWhatIfOnManagementGroup.json | 87 -
.../PostDeploymentWhatIfOnResourceGroup.json | 73 -
.../PostDeploymentWhatIfOnSubscription.json | 84 -
.../PostDeploymentWhatIfOnTenant.json | 40 -
.../PutDeploymentAtManagementGroup.json | 139 -
.../examples/PutDeploymentAtScope.json | 151 -
.../examples/PutDeploymentAtTenant.json | 150 -
.../examples/PutDeploymentResourceGroup.json | 93 -
...ymentResourceGroupTemplateSpecsWithId.json | 92 -
...oymentSubscriptionTemplateSpecsWithId.json | 66 -
...ntWithOnErrorDeploymentLastSuccessful.json | 168 -
...thOnErrorDeploymentSpecificDeployment.json | 169 -
.../2022-12-01/examples/PutTagsResource.json | 26 -
.../examples/PutTagsSubscription.json | 26 -
.../stable/2022-12-01/resources.json | 6446 -----------------
27 files changed, 8596 deletions(-)
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
delete mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
deleted file mode 100644
index f028ed6a82d9..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CalculateTemplateHash.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
- "parameters": {
- "api-version": "2022-12-01",
- "template": {
- "$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview",
- "contentVersion": "1.0.0.0",
- "parameters": {
- "string": {
- "type": "string"
- }
- },
- "variables": {
- "string": "string",
- "int": 42,
- "bool": true,
- "array": [
- 1,
- 2,
- 3,
- 4
- ],
- "object": {
- "object": {
- "vmSize": "Large",
- "location": "West US"
- }
- }
- },
- "resources": [],
- "outputs": {
- "string": {
- "type": "string",
- "value": "myvalue"
- }
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "minifiedTemplate": "{\"$SCHEMA\":\"HTTP://SCHEMAS.MANAGEMENT.AZURE.COM/DEPLOYMENTTEMPLATE?API-VERSION=2014-04-01-PREVIEW\",\"CONTENTVERSION\":\"1.0.0.0\",\"PARAMETERS\":{\"STRING\":{\"TYPE\":\"STRING\"}},\"VARIABLES\":{\"STRING\":\"STRING\",\"INT\":42,\"BOOL\":TRUE,\"ARRAY\":[1,2,3,4],\"OBJECT\":{\"OBJECT\":{\"VMSIZE\":\"LARGE\",\"LOCATION\":\"WEST US\"}}},\"RESOURCES\":[],\"OUTPUTS\":{\"STRING\":{\"TYPE\":\"STRING\",\"VALUE\":\"MYVALUE\"}}}",
- "templateHash": "695440707931307747"
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
deleted file mode 100644
index a713e0e9dacb..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/CreateResourceGroup.json
+++ /dev/null
@@ -1,32 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus"
- }
- },
- "responses": {
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
- "name": "my-resource-group",
- "location": "eastus",
- "properties": {
- "provisioningState": "Succeeded"
- }
- }
- },
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group",
- "name": "my-resource-group",
- "location": "eastus",
- "properties": {
- "provisioningState": "Succeeded"
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
deleted file mode 100644
index b8a0fc247e92..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroup.json
+++ /dev/null
@@ -1,68 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "api-version": "2022-12-01",
- "parameters": {
- "resources": [
- "*"
- ],
- "options": "IncludeParameterDefaultValue,IncludeComments"
- }
- },
- "responses": {
- "202": {
- "headers": {
- "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
- }
- },
- "200": {
- "body": {
- "template": {
- "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
- "contentVersion": "1.0.0.0",
- "parameters": {
- "myResourceType_myFirstResource_name": {
- "defaultValue": "myFirstResource",
- "type": "String"
- },
- "myResourceType_mySecondResource_name": {
- "defaultValue": "mySecondResource",
- "type": "String"
- },
- "myResourceType_myFirstResource_secret": {
- "defaultValue": null,
- "type": "SecureString"
- }
- },
- "variables": {},
- "resources": [
- {
- "type": "My.RP/myResourceType",
- "apiVersion": "2019-01-01",
- "name": "[parameters('myResourceType_myFirstResource_name')]",
- "location": "West US",
- "properties": {
- "secret": "[parameters('myResourceType_myFirstResource_secret')]"
- }
- },
- {
- "type": "My.RP/myResourceType",
- "apiVersion": "2019-01-01",
- "name": "[parameters('myResourceType_mySecondResource_name')]",
- "location": "West US",
- "properties": {
- "customProperty": "hello!"
- }
- }
- ]
- },
- "error": {
- "code": "ExportTemplateCompletedWithErrors",
- "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.",
- "details": []
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
deleted file mode 100644
index 6451335df801..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ExportResourceGroupWithFiltering.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "api-version": "2022-12-01",
- "parameters": {
- "resources": [
- "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource"
- ],
- "options": "SkipResourceNameParameterization"
- }
- },
- "responses": {
- "202": {
- "headers": {
- "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01"
- }
- },
- "200": {
- "body": {
- "template": {
- "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
- "contentVersion": "1.0.0.0",
- "parameters": {
- "myResourceType_myFirstResource_secret": {
- "defaultValue": null,
- "type": "SecureString"
- }
- },
- "variables": {},
- "resources": [
- {
- "type": "My.RP/myResourceType",
- "apiVersion": "2019-01-01",
- "name": "myFirstResource",
- "location": "West US",
- "properties": {
- "secret": "[parameters('myResourceType_myFirstResource_secret')]"
- }
- }
- ]
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
deleted file mode 100644
index 8a76d9a606ee..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsAndVMSSInResourceGroup.json
+++ /dev/null
@@ -1,16 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "forceDeletionTypes": "Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets",
- "api-version": "2022-12-01"
- },
- "responses": {
- "202": {
- "description": "Accepted"
- },
- "200": {
- "description": "OK"
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
deleted file mode 100644
index 2dc0365dac0d..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/ForceDeleteVMsInResourceGroup.json
+++ /dev/null
@@ -1,16 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "forceDeletionTypes": "Microsoft.Compute/virtualMachines",
- "api-version": "2022-12-01"
- },
- "responses": {
- "202": {
- "description": "Accepted"
- },
- "200": {
- "description": "OK"
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
deleted file mode 100644
index 7343b6a90d0a..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetNamedProviderAtTenant.json
+++ /dev/null
@@ -1,253 +0,0 @@
-{
- "parameters": {
- "$expand": "resourceTypes/aliases",
- "resourceProviderNamespace": "Microsoft.Storage",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "namespace": "Microsoft.Storage",
- "resourceTypes": [
- {
- "resourceType": "storageAccounts",
- "locations": [
- "East US",
- "East US 2",
- "East US 2 (Stage)",
- "West US",
- "West Europe",
- "East Asia",
- "Southeast Asia",
- "Japan East",
- "Japan West",
- "North Central US",
- "South Central US",
- "Central US",
- "North Europe",
- "Brazil South",
- "Australia East",
- "Australia Southeast",
- "South India",
- "Central India",
- "West India",
- "Canada East",
- "Canada Central",
- "West US 2",
- "West Central US",
- "UK South",
- "UK West",
- "Korea Central",
- "Korea South",
- "East US 2 EUAP",
- "Central US EUAP",
- "France Central",
- "France South",
- "Australia Central",
- "Australia Central 2",
- "South Africa West",
- "South Africa North",
- "UAE Central",
- "UAE North",
- "Switzerland North",
- "Switzerland West",
- "Germany West Central",
- "Germany North",
- "Norway East",
- "Norway West",
- "South Central US STG",
- "Brazil Southeast"
- ],
- "apiVersions": [
- "2019-06-01",
- "2019-04-01",
- "2018-11-01",
- "2018-07-01",
- "2018-03-01-preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01",
- "2015-06-15",
- "2015-05-01-preview"
- ],
- "defaultApiVersion": "2019-06-01",
- "apiProfiles": [
- {
- "profileVersion": "2019-03-01-hybrid",
- "apiVersion": "2017-10-01"
- },
- {
- "profileVersion": "2017-03-09-profile",
- "apiVersion": "2016-01-01"
- },
- {
- "profileVersion": "2018-03-01-hybrid",
- "apiVersion": "2016-01-01"
- },
- {
- "profileVersion": "2018-06-01-profile",
- "apiVersion": "2017-10-01"
- }
- ],
- "aliases": [
- {
- "name": "Microsoft.Storage/storageAccounts/accountType",
- "paths": [
- {
- "path": "properties.accountType",
- "apiVersions": [
- "2015-06-15",
- "2015-05-01-preview"
- ]
- },
- {
- "path": "sku.name",
- "apiVersions": [
- "2018-11-01",
- "2018-11-09",
- "2018-07-01",
- "2018-03-01-Preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01"
- ]
- }
- ],
- "defaultPath": "sku.name"
- },
- {
- "name": "Microsoft.Storage/storageAccounts/sku.name",
- "paths": [
- {
- "path": "properties.accountType",
- "apiVersions": [
- "2015-06-15",
- "2015-05-01-preview"
- ]
- },
- {
- "path": "sku.name",
- "apiVersions": [
- "2018-11-01",
- "2018-11-09",
- "2018-07-01",
- "2018-03-01-Preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01"
- ]
- }
- ],
- "defaultPath": "sku.name"
- },
- {
- "name": "Microsoft.Storage/storageAccounts/accessTier",
- "paths": [
- {
- "path": "properties.accessTier",
- "apiVersions": [
- "2018-11-01",
- "2018-11-09",
- "2018-07-01",
- "2018-03-01-Preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01",
- "2015-06-15",
- "2015-05-01-preview"
- ]
- }
- ],
- "defaultPath": "properties.accessTier"
- },
- {
- "name": "Microsoft.Storage/storageAccounts/enableBlobEncryption",
- "paths": [
- {
- "path": "properties.encryption.services.blob.enabled",
- "apiVersions": [
- "2018-11-01",
- "2018-11-09",
- "2018-07-01",
- "2018-03-01-Preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01",
- "2015-06-15",
- "2015-05-01-preview"
- ]
- }
- ],
- "defaultPath": "properties.encryption.services.blob.enabled"
- },
- {
- "name": "Microsoft.Storage/storageAccounts/enableFileEncryption",
- "paths": [
- {
- "path": "properties.encryption.services.file.enabled",
- "apiVersions": [
- "2018-11-01",
- "2018-11-09",
- "2018-07-01",
- "2018-03-01-Preview",
- "2018-02-01",
- "2017-10-01",
- "2017-06-01",
- "2016-12-01",
- "2016-05-01",
- "2016-01-01",
- "2015-06-15",
- "2015-05-01-preview"
- ]
- }
- ],
- "defaultPath": "properties.encryption.services.file.enabled"
- },
- {
- "name": "Microsoft.Storage/storageAccounts/supportsHttpsTrafficOnly",
- "paths": [
- {
- "path": "properties.supportsHttpsTrafficOnly",
- "apiVersions": [
- "2018-11-09",
- "2018-03-01-Preview",
- "2016-05-01",
- "2016-01-01",
- "2015-06-15",
- "2015-05-01-preview"
- ],
- "metadata": {
- "type": "NotSpecified",
- "attributes": "None"
- }
- }
- ],
- "defaultPath": "properties.supportsHttpsTrafficOnly",
- "defaultMetadata": {
- "type": "Boolean",
- "attributes": "Modifiable"
- }
- }
- ],
- "capabilities": "SupportsTags, SupportsLocation"
- }
- ]
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
deleted file mode 100644
index 584abd44e259..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProvider.json
+++ /dev/null
@@ -1,51 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceProviderNamespace": "Microsoft.TestRP1",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
- "namespace": "Microsoft.TestRP1",
- "registrationState": "Registering",
- "registrationPolicy": "RegistrationRequired",
- "resourceTypes": [
- {
- "resourceType": "TestResourceType",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "locationMappings": [
- {
- "location": "West US",
- "type": "EdgeZone",
- "extendedLocations": [
- "LosAngeles",
- "LosAngeles2"
- ]
- }
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "TestResourceTypeSibling",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- }
- ]
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
deleted file mode 100644
index bfb5ec72716c..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviderResourceTypes.json
+++ /dev/null
@@ -1,47 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceProviderNamespace": "Microsoft.TestRP",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "value": [
- {
- "resourceType": "TestResourceType",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "locationMappings": [
- {
- "location": "West US",
- "type": "EdgeZone",
- "extendedLocations": [
- "LosAngeles",
- "LosAngeles2"
- ]
- }
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "TestResourceTypeSibling",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- }
- ]
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
deleted file mode 100644
index 27ddc0015c8d..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetProviders.json
+++ /dev/null
@@ -1,175 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "value": [
- {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP1",
- "namespace": "Microsoft.TestRP1",
- "registrationState": "Registering",
- "registrationPolicy": "RegistrationRequired",
- "resourceTypes": [
- {
- "resourceType": "TestResourceType",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "locationMappings": [
- {
- "location": "West US",
- "type": "EdgeZone",
- "extendedLocations": [
- "LosAngeles",
- "LosAngeles2"
- ]
- }
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "TestResourceTypeSibling",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- }
- ]
- },
- {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources",
- "namespace": "Microsoft.Resources",
- "registrationState": "Registered",
- "registrationPolicy": "RegistrationFree",
- "resourceTypes": [
- {
- "resourceType": "subscriptions",
- "locations": [
- "eastus",
- "eastus2",
- "westus"
- ],
- "apiVersions": [
- "2016-09-01",
- "2014-04-01-preview"
- ],
- "aliases": [],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "resourceGroups",
- "locations": [
- "centralus",
- "eastasia",
- "southeastasia"
- ],
- "apiVersions": [
- "2016-09-01",
- "2014-04-01-preview"
- ],
- "aliases": [],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "subscriptions/resourceGroups",
- "locations": [
- "eastus",
- "eastus2",
- "westus"
- ],
- "apiVersions": [
- "2016-09-01",
- "2014-04-01-preview"
- ],
- "aliases": [],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "bulkDelete",
- "locations": [
- "centralus",
- "eastasia"
- ],
- "apiVersions": [
- "2014-04-01-preview"
- ],
- "aliases": [],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "deployments",
- "locations": [],
- "apiVersions": [
- "2017-08-01",
- "2017-06-01"
- ],
- "aliases": [],
- "capabilities": "SupportsTags"
- },
- {
- "resourceType": "tags",
- "locations": [
- "DevFabric"
- ],
- "apiVersions": [],
- "aliases": [],
- "capabilities": "SupportsExtension"
- }
- ]
- },
- {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestRP2",
- "namespace": "Microsoft.TestRP2",
- "registrationState": "NotRegistered",
- "registrationPolicy": "RegistrationRequired",
- "resourceTypes": [
- {
- "resourceType": "TestResourceType",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "locationMappings": [
- {
- "location": "West US",
- "type": "EdgeZone",
- "extendedLocations": [
- "LosAngeles",
- "LosAngeles2"
- ]
- }
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- },
- {
- "resourceType": "TestResourceTypeSibling",
- "locations": [
- "West US"
- ],
- "apiVersions": [
- "2018-01-01",
- "2015-05-01"
- ],
- "capabilities": "CrossResourceGroupResourceMove, CrossSubscriptionResourceMove, SupportsTags, SupportsLocation"
- }
- ]
- }
- ]
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
deleted file mode 100644
index b51eba832ae5..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsResource.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "parameters": {
- "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
deleted file mode 100644
index 43f93617317b..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetTagsSubscription.json
+++ /dev/null
@@ -1,18 +0,0 @@
-{
- "parameters": {
- "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
- "api-version": "2022-12-01"
- },
- "responses": {
- "200": {
- "body": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
deleted file mode 100644
index 291e2019a779..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnManagementGroup.json
+++ /dev/null
@@ -1,87 +0,0 @@
-{
- "parameters": {
- "groupId": "myManagementGruop",
- "deploymentName": "exampleDeploymentName",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": "https://example.com/exampleTemplate.json",
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "status": "Succeeded",
- "properties": {
- "changes": [
- {
- "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
- "changeType": "Modify",
- "before": {
- "apiVersion": "2019-06-01",
- "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
- "type": "Microsoft.Authorization/policyAssignments",
- "name": "myPolicyAssignment",
- "location": "westus2",
- "properties": {
- "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
- "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
- "enforcementMode": "Default"
- }
- },
- "after": {
- "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
- "changeType": "Modify",
- "before": {
- "apiVersion": "2019-06-01",
- "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
- "type": "Microsoft.Authorization/policyAssignments",
- "name": "myPolicyAssignment",
- "location": "westus2",
- "properties": {
- "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
- "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
- "enforcementMode": "DoNotEnforce"
- }
- },
- "delta": [
- {
- "path": "properties.enforcementMode",
- "propertyChangeType": "Modify",
- "before": "Default",
- "after": "DoNotEnforce"
- }
- ]
- }
- },
- {
- "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
- "changeType": "Create",
- "after": {
- "apiVersion": "2019-06-01",
- "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
- "type": "Microsoft.Authorization/policyAssignments",
- "name": "myPolicyAssignment2",
- "location": "westus2",
- "properties": {
- "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
- "scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
- "enforcementMode": "Default"
- }
- }
- }
- ]
- }
- }
- },
- "202": {
- "headers": {
- "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
deleted file mode 100644
index 2591a761c82a..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnResourceGroup.json
+++ /dev/null
@@ -1,73 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000001",
- "resourceGroupName": "my-resource-group",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "templateLink": "https://example.com/exampleTemplate.json",
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "status": "succeeded",
- "properties": {
- "changes": [
- {
- "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "changeType": "Modify",
- "before": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myExistingIdentity",
- "location": "westus2"
- },
- "after": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myExistingIdentity",
- "location": "westus2",
- "tags": {
- "myNewTag": "my tag value"
- }
- },
- "delta": [
- {
- "path": "tags.myNewTag",
- "propertyChangeType": "Create",
- "after": "my tag value"
- }
- ]
- },
- {
- "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
- "changeType": "Create",
- "after": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myNewIdentity",
- "location": "eastus",
- "tags": {
- "myOtherNewTag": "another new tag value"
- }
- }
- }
- ]
- }
- }
- },
- "202": {
- "headers": {
- "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
deleted file mode 100644
index 86e7241b2a95..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnSubscription.json
+++ /dev/null
@@ -1,84 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000001",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "westus",
- "properties": {
- "templateLink": "https://example.com/exampleTemplate.json",
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "status": "succeeded",
- "properties": {
- "changes": [
- {
- "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "changeType": "Modify",
- "before": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myExistingIdentity",
- "location": "westus2"
- },
- "after": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myExistingIdentity",
- "location": "westus2",
- "tags": {
- "myNewTag": "my tag value"
- }
- },
- "delta": [
- {
- "path": "tags.myNewTag",
- "propertyChangeType": "Create",
- "after": "my tag value"
- }
- ]
- },
- {
- "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
- "changeType": "Create",
- "after": {
- "apiVersion": "2018-11-30",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
- "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
- "name": "myNewIdentity",
- "location": "eastus",
- "tags": {
- "myOtherNewTag": "another new tag value"
- }
- }
- },
- {
- "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
- "changeType": "Create",
- "after": {
- "apiVersion": "2019-03-01",
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
- "type": "Microsoft.Resources/resourceGroups",
- "name": "my-resource-group2",
- "location": "{location3}"
- }
- }
- ]
- }
- }
- },
- "202": {
- "headers": {
- "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
deleted file mode 100644
index 38f42ea09fbf..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostDeploymentWhatIfOnTenant.json
+++ /dev/null
@@ -1,40 +0,0 @@
-{
- "parameters": {
- "deploymentName": "exampleDeploymentName",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": "https://example.com/exampleTemplate.json",
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "status": "Succeeded",
- "properties": {
- "changes": [
- {
- "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
- "changeType": "Create",
- "after": {
- "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
- "apiVersion": "2019-11-01",
- "type": "Microsoft.Management/managementGroups",
- "name": "myManagementGroup"
- }
- }
- ]
- }
- }
- },
- "202": {
- "headers": {
- "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
deleted file mode 100644
index 0ba35b815a9b..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtManagementGroup.json
+++ /dev/null
@@ -1,139 +0,0 @@
-{
- "parameters": {
- "groupId": "my-management-group-id",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json"
- },
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- }
- }
- },
- "201": {
- "body": {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
deleted file mode 100644
index 34dc0546bb54..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtScope.json
+++ /dev/null
@@ -1,151 +0,0 @@
-{
- "parameters": {
- "scope": "providers/Microsoft.Management/managementGroups/my-management-group-id",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json"
- },
- "parameters": {},
- "mode": "Incremental"
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- },
- "201": {
- "body": {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
deleted file mode 100644
index 7593a8d1a8b8..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentAtTenant.json
+++ /dev/null
@@ -1,150 +0,0 @@
-{
- "parameters": {
- "deploymentName": "tenant-dep01",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json"
- },
- "parameters": {},
- "mode": "Incremental"
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
- "name": "tenant-dep01",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- },
- "201": {
- "body": {
- "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
- "name": "tenant-dep01",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2019-04-24T22:52:38.7895563Z",
- "duration": "PT1.2970875S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Authorization",
- "resourceTypes": [
- {
- "resourceType": "policyDefinitions",
- "locations": [
- null
- ]
- },
- {
- "resourceType": "policyAssignments",
- "locations": [
- null
- ]
- }
- ]
- },
- {
- "namespace": "Microsoft.Resources",
- "resourceTypes": [
- {
- "resourceType": "deployments",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
- "resourceType": "Microsoft.Authorization/policyDefinitions",
- "resourceName": "policy-definition-name"
- }
- ],
- "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
- "resourceType": "Microsoft.Authorization/policyAssignments",
- "resourceName": "location-lock"
- }
- ]
- },
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
deleted file mode 100644
index c46a87591176..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroup.json
+++ /dev/null
@@ -1,93 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000001",
- "resourceGroupName": "my-resource-group",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json",
- "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"
- },
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Succeeded",
- "timestamp": "2020-06-05T01:20:01.723776Z",
- "duration": "PT22.8356799S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Storage",
- "resourceTypes": [
- {
- "resourceType": "storageAccounts",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [],
- "outputResources": [
- {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
- }
- ]
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2020-06-05T01:20:01.723776Z",
- "duration": "PT22.8356799S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Storage",
- "resourceTypes": [
- {
- "resourceType": "storageAccounts",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": []
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
deleted file mode 100644
index 814c8664839b..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json
+++ /dev/null
@@ -1,92 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000001",
- "resourceGroupName": "my-resource-group",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
- },
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Succeeded",
- "timestamp": "2020-06-05T01:20:01.723776Z",
- "duration": "PT22.8356799S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Storage",
- "resourceTypes": [
- {
- "resourceType": "storageAccounts",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": [],
- "outputResources": [
- {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
- }
- ]
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2020-06-05T01:20:01.723776Z",
- "duration": "PT22.8356799S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Storage",
- "resourceTypes": [
- {
- "resourceType": "storageAccounts",
- "locations": [
- "eastus"
- ]
- }
- ]
- }
- ],
- "dependencies": []
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
deleted file mode 100644
index 1c6b228481af..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json
+++ /dev/null
@@ -1,66 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000001",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "location": "eastus",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
- },
- "parameters": {},
- "mode": "Incremental"
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Succeeded",
- "timestamp": "2020-06-05T01:51:58.6288067Z",
- "duration": "PT1.2637681S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [],
- "dependencies": [],
- "outputResources": []
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "location": "eastus",
- "properties": {
- "templateLink": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
- "contentVersion": "1.0.0.0"
- },
- "templateHash": "0000000000000000000",
- "parameters": {},
- "mode": "Incremental",
- "provisioningState": "Accepted",
- "timestamp": "2020-06-05T01:51:58.6288067Z",
- "duration": "PT1.2637681S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [],
- "dependencies": []
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
deleted file mode 100644
index 25b06868ca06..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json
+++ /dev/null
@@ -1,168 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json"
- },
- "parameters": {},
- "mode": "Complete",
- "onErrorDeployment": {
- "type": "LastSuccessful"
- }
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json",
- "contentVersion": "1.0.0.0"
- },
- "parameters": {},
- "mode": "Complete",
- "provisioningState": "Accepted",
- "timestamp": "2019-03-01T00:00:00.0000000Z",
- "duration": "PT0.8204881S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Network",
- "resourceTypes": [
- {
- "resourceType": "virtualNetworks",
- "locations": [
- "centralus"
- ]
- },
- {
- "resourceType": "virtualNetworks/subnets",
- "locations": [
- "centralus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- },
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- },
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet2"
- }
- ],
- "onErrorDeployment": {
- "type": "LastSuccessful",
- "deploymentName": "{nameOfLastSuccesfulDeployment}"
- }
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json",
- "contentVersion": "1.0.0.0"
- },
- "parameters": {},
- "mode": "Complete",
- "provisioningState": "Accepted",
- "timestamp": "2019-03-01T00:00:00.0000000Z",
- "duration": "PT0.8204881S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Network",
- "resourceTypes": [
- {
- "resourceType": "virtualNetworks",
- "locations": [
- "centralus"
- ]
- },
- {
- "resourceType": "virtualNetworks/subnets",
- "locations": [
- "centralus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- },
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- },
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet2"
- }
- ],
- "onErrorDeployment": {
- "type": "LastSuccessful",
- "deploymentName": "{nameOfLastSuccesfulDeployment}"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
deleted file mode 100644
index be56b7a76487..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json
+++ /dev/null
@@ -1,169 +0,0 @@
-{
- "parameters": {
- "subscriptionId": "00000000-0000-0000-0000-000000000000",
- "resourceGroupName": "my-resource-group",
- "deploymentName": "my-deployment",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json"
- },
- "parameters": {},
- "mode": "Complete",
- "onErrorDeployment": {
- "type": "SpecificDeployment",
- "deploymentName": "name-of-deployment-to-use"
- }
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json",
- "contentVersion": "1.0.0.0"
- },
- "parameters": {},
- "mode": "Complete",
- "provisioningState": "Accepted",
- "timestamp": "2019-03-01T00:00:00.0000000Z",
- "duration": "PT0.8204881S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Network",
- "resourceTypes": [
- {
- "resourceType": "virtualNetworks",
- "locations": [
- "centralus"
- ]
- },
- {
- "resourceType": "virtualNetworks/subnets",
- "locations": [
- "centralus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- },
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- },
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet2"
- }
- ],
- "onErrorDeployment": {
- "type": "SpecificDeployment",
- "deploymentName": "name-of-deployment-to-use"
- }
- }
- }
- },
- "201": {
- "body": {
- "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
- "name": "my-deployment",
- "type": "Microsoft.Resources/deployments",
- "properties": {
- "templateLink": {
- "uri": "https://example.com/exampleTemplate.json",
- "contentVersion": "1.0.0.0"
- },
- "parameters": {},
- "mode": "Complete",
- "provisioningState": "Accepted",
- "timestamp": "2019-03-01T00:00:00.0000000Z",
- "duration": "PT0.8204881S",
- "correlationId": "00000000-0000-0000-0000-000000000000",
- "providers": [
- {
- "namespace": "Microsoft.Network",
- "resourceTypes": [
- {
- "resourceType": "virtualNetworks",
- "locations": [
- "centralus"
- ]
- },
- {
- "resourceType": "virtualNetworks/subnets",
- "locations": [
- "centralus"
- ]
- }
- ]
- }
- ],
- "dependencies": [
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- },
- {
- "dependsOn": [
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks",
- "resourceName": "VNet1"
- },
- {
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet1"
- }
- ],
- "id": "{resourceid}",
- "resourceType": "Microsoft.Network/virtualNetworks/subnets",
- "resourceName": "VNet1/Subnet2"
- }
- ],
- "onErrorDeployment": {
- "type": "SpecificDeployment",
- "deploymentName": "name-of-deployment-to-use"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
deleted file mode 100644
index ea6697821841..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsResource.json
+++ /dev/null
@@ -1,26 +0,0 @@
-{
- "parameters": {
- "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
deleted file mode 100644
index 78a72c3d436c..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PutTagsSubscription.json
+++ /dev/null
@@ -1,26 +0,0 @@
-{
- "parameters": {
- "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
- "api-version": "2022-12-01",
- "parameters": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- },
- "responses": {
- "200": {
- "body": {
- "properties": {
- "tags": {
- "tagKey1": "tag-value-1",
- "tagKey2": "tag-value-2"
- }
- }
- }
- }
- }
-}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
deleted file mode 100644
index 2b1e32082928..000000000000
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/resources.json
+++ /dev/null
@@ -1,6446 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "title": "ResourceManagementClient",
- "version": "2021-01-01",
- "description": "Provides operations for working with resources and resource groups."
- },
- "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.Resources/operations": {
- "get": {
- "tags": [
- "Operations"
- ],
- "operationId": "Operations_List",
- "description": "Lists all of the available Microsoft.Resources REST API operations.",
- "parameters": [
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK. The request has succeeded.",
- "schema": {
- "$ref": "#/definitions/OperationListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_DeleteAtScope",
- "summary": "Deletes a deployment from the deployment history.",
- "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted - Returns this status until the asynchronous operation has completed."
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "head": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CheckExistenceAtScope",
- "description": "Checks whether the deployment exists.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CreateOrUpdateAtScope",
- "summary": "Deploys resources at a given scope.",
- "description": "You can provide the template and parameters directly in the request or link to JSON files.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Additional parameters supplied to the operation."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "201": {
- "description": "Created - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-examples": {
- "Create deployment at a given scope.": {
- "$ref": "./examples/PutDeploymentAtScope.json"
- }
- }
- },
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_GetAtScope",
- "description": "Gets a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CancelAtScope",
- "summary": "Cancels a currently running template deployment.",
- "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ValidateAtScope",
- "x-ms-long-running-operation": true,
- "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "202": {
- "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
- },
- "400": {
- "description": "Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ExportTemplateAtScope",
- "description": "Exports the template used for specified deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the template.",
- "schema": {
- "$ref": "#/definitions/DeploymentExportResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/": {
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ListAtScope",
- "description": "Get all the deployments at the given scope.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to get. If null is passed, returns all deployments."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of deployments.",
- "schema": {
- "$ref": "#/definitions/DeploymentListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_DeleteAtTenantScope",
- "summary": "Deletes a deployment from the deployment history.",
- "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted - Returns this status until the asynchronous operation has completed."
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "head": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CheckExistenceAtTenantScope",
- "description": "Checks whether the deployment exists.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CreateOrUpdateAtTenantScope",
- "summary": "Deploys resources at tenant scope.",
- "description": "You can provide the template and parameters directly in the request or link to JSON files.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeployment"
- },
- "description": "Additional parameters supplied to the operation."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "201": {
- "description": "Created - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-examples": {
- "Create deployment at tenant scope.": {
- "$ref": "./examples/PutDeploymentAtTenant.json"
- }
- }
- },
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_GetAtTenantScope",
- "description": "Gets a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CancelAtTenantScope",
- "summary": "Cancels a currently running template deployment.",
- "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ValidateAtTenantScope",
- "x-ms-long-running-operation": true,
- "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeployment"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "202": {
- "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
- },
- "400": {
- "description": "Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_WhatIfAtTenantScope",
- "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeploymentWhatIf"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns What-If operation status",
- "schema": {
- "$ref": "#/definitions/WhatIfOperationResult"
- }
- },
- "202": {
- "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
- "headers": {
- "Location": {
- "type": "string",
- "description": "URL to get status of this long-running operation."
- },
- "Retry-After": {
- "type": "string",
- "description": "Number of seconds to wait before polling for status."
- }
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Predict template changes at management group scope": {
- "$ref": "./examples/PostDeploymentWhatIfOnTenant.json"
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "location"
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ExportTemplateAtTenantScope",
- "description": "Exports the template used for specified deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the template.",
- "schema": {
- "$ref": "#/definitions/DeploymentExportResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/": {
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ListAtTenantScope",
- "description": "Get all the deployments at the tenant scope.",
- "parameters": [
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to get. If null is passed, returns all deployments."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of deployments.",
- "schema": {
- "$ref": "#/definitions/DeploymentListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_DeleteAtManagementGroupScope",
- "summary": "Deletes a deployment from the deployment history.",
- "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted - Returns this status until the asynchronous operation has completed."
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "head": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CheckExistenceAtManagementGroupScope",
- "description": "Checks whether the deployment exists.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CreateOrUpdateAtManagementGroupScope",
- "summary": "Deploys resources at management group scope.",
- "description": "You can provide the template and parameters directly in the request or link to JSON files.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeployment"
- },
- "description": "Additional parameters supplied to the operation."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "201": {
- "description": "Created - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-examples": {
- "Create deployment at management group scope.": {
- "$ref": "./examples/PutDeploymentAtManagementGroup.json"
- }
- }
- },
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_GetAtManagementGroupScope",
- "description": "Gets a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CancelAtManagementGroupScope",
- "summary": "Cancels a currently running template deployment.",
- "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ValidateAtManagementGroupScope",
- "x-ms-long-running-operation": true,
- "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeployment"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "202": {
- "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
- },
- "400": {
- "description": "Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_WhatIfAtManagementGroupScope",
- "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ScopedDeploymentWhatIf"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns What-If operation status",
- "schema": {
- "$ref": "#/definitions/WhatIfOperationResult"
- }
- },
- "202": {
- "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
- "headers": {
- "Location": {
- "type": "string",
- "description": "URL to get status of this long-running operation."
- },
- "Retry-After": {
- "type": "string",
- "description": "Number of seconds to wait before polling for status."
- }
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Predict template changes at management group scope": {
- "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json"
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "location"
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ExportTemplateAtManagementGroupScope",
- "description": "Exports the template used for specified deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the template.",
- "schema": {
- "$ref": "#/definitions/DeploymentExportResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/": {
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ListAtManagementGroupScope",
- "description": "Get all the deployments for a management group.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to get. If null is passed, returns all deployments."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of deployments.",
- "schema": {
- "$ref": "#/definitions/DeploymentListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_DeleteAtSubscriptionScope",
- "summary": "Deletes a deployment from the deployment history.",
- "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted - Returns this status until the asynchronous operation has completed."
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "head": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CheckExistenceAtSubscriptionScope",
- "description": "Checks whether the deployment exists.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope",
- "summary": "Deploys resources at subscription scope.",
- "description": "You can provide the template and parameters directly in the request or link to JSON files.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Additional parameters supplied to the operation."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "201": {
- "description": "Created - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Create a deployment that will deploy a templateSpec with the given resourceId": {
- "$ref": "./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json"
- }
- },
- "x-ms-long-running-operation": true
- },
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_GetAtSubscriptionScope",
- "description": "Gets a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CancelAtSubscriptionScope",
- "summary": "Cancels a currently running template deployment.",
- "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ValidateAtSubscriptionScope",
- "x-ms-long-running-operation": true,
- "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "202": {
- "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
- },
- "400": {
- "description": "Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_WhatIfAtSubscriptionScope",
- "description": "Returns changes that will be made by the deployment if executed at the scope of the subscription.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeploymentWhatIf"
- },
- "description": "Parameters to What If."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns What-If operation status",
- "schema": {
- "$ref": "#/definitions/WhatIfOperationResult"
- }
- },
- "202": {
- "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
- "headers": {
- "Location": {
- "type": "string",
- "description": "URL to get status of this long-running operation."
- },
- "Retry-After": {
- "type": "string",
- "description": "Number of seconds to wait before polling for status."
- }
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Predict template changes at subscription scope": {
- "$ref": "./examples/PostDeploymentWhatIfOnSubscription.json"
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "location"
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ExportTemplateAtSubscriptionScope",
- "description": "Exports the template used for specified deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the template.",
- "schema": {
- "$ref": "#/definitions/DeploymentExportResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/": {
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ListAtSubscriptionScope",
- "description": "Get all the deployments for a subscription.",
- "parameters": [
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to get. If null is passed, returns all deployments."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of deployments.",
- "schema": {
- "$ref": "#/definitions/DeploymentListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": {
- "delete": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_Delete",
- "summary": "Deletes a deployment from the deployment history.",
- "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group with the deployment to delete. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted - Returns this status until the asynchronous operation has completed."
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "head": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CheckExistence",
- "description": "Checks whether the deployment exists.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group with the deployment to check. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CreateOrUpdate",
- "summary": "Deploys resources to a resource group.",
- "description": "You can provide the template and parameters directly in the request or link to JSON files.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Additional parameters supplied to the operation."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "201": {
- "description": "Created - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Create a deployment that will redeploy the last successful deployment on failure": {
- "$ref": "./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json"
- },
- "Create a deployment that will redeploy another deployment on failure": {
- "$ref": "./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json"
- },
- "Create a deployment that will deploy a templateSpec with the given resourceId": {
- "$ref": "./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json"
- },
- "Create a deployment that will deploy a template with a uri and queryString": {
- "$ref": "./examples/PutDeploymentResourceGroup.json"
- }
- },
- "x-ms-long-running-operation": true
- },
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_Get",
- "description": "Gets a deployment.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment, including provisioning status.",
- "schema": {
- "$ref": "#/definitions/DeploymentExtended"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_Cancel",
- "summary": "Cancels a currently running template deployment.",
- "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_Validate",
- "x-ms-long-running-operation": true,
- "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/Deployment"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "202": {
- "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously."
- },
- "400": {
- "description": "Returns the validation result.",
- "schema": {
- "$ref": "#/definitions/DeploymentValidateResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_WhatIf",
- "description": "Returns changes that will be made by the deployment if executed at the scope of the resource group.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group the template will be deployed to. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeploymentWhatIf"
- },
- "description": "Parameters to validate."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns What-If operation status",
- "schema": {
- "$ref": "#/definitions/WhatIfOperationResult"
- }
- },
- "202": {
- "description": "Accepted - Returns URL in Location header to query for long-running operation status.",
- "headers": {
- "Location": {
- "type": "string",
- "description": "URL to get status of this long-running operation."
- },
- "Retry-After": {
- "type": "string",
- "description": "Number of seconds to wait before polling for status."
- }
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Predict template changes at resource group scope": {
- "$ref": "./examples/PostDeploymentWhatIfOnResourceGroup.json"
- }
- },
- "x-ms-long-running-operation": true,
- "x-ms-long-running-operation-options": {
- "final-state-via": "location"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ExportTemplate",
- "description": "Exports the template used for specified deployment.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns the template.",
- "schema": {
- "$ref": "#/definitions/DeploymentExportResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": {
- "get": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_ListByResourceGroup",
- "description": "Get all the deployments for a resource group.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group with the deployments to get. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to get. If null is passed, returns all deployments."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of deployments.",
- "schema": {
- "$ref": "#/definitions/DeploymentListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/DeploymentExtendedFilter"
- }
- },
- "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": {
- "post": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_Unregister",
- "description": "Unregisters a subscription from a resource provider.",
- "parameters": [
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider to unregister."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource provider.",
- "schema": {
- "$ref": "#/definitions/Provider"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register": {
- "post": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_RegisterAtManagementGroupScope",
- "description": "Registers a management group with a resource provider.",
- "parameters": [
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider to register."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/GroupIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource provider."
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": {
- "post": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_Register",
- "description": "Registers a subscription with a resource provider.",
- "parameters": [
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider to register."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource provider.",
- "schema": {
- "$ref": "#/definitions/Provider"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers": {
- "get": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_List",
- "description": "Gets all resource providers for a subscription.",
- "parameters": [
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return. If null is passed returns all deployments."
- },
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of resource providers.",
- "schema": {
- "$ref": "#/definitions/ProviderListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-examples": {
- "Get providers.": {
- "$ref": "./examples/GetProviders.json"
- }
- }
- }
- },
- "/providers": {
- "get": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_ListAtTenantScope",
- "description": "Gets all resource providers for the tenant.",
- "parameters": [
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return. If null is passed returns all providers."
- },
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of resource providers.",
- "schema": {
- "$ref": "#/definitions/ProviderListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": {
- "get": {
- "tags": [
- "Providers"
- ],
- "operationId": "Providers_Get",
- "description": "Gets the specified resource provider.",
- "parameters": [
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource provider.",
- "schema": {
- "$ref": "#/definitions/Provider"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Get provider.": {
- "$ref": "./examples/GetProvider.json"
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes": {
- "get": {
- "tags": [
- "Providers"
- ],
- "operationId": "ProviderResourceTypes_List",
- "description": "List the resource types for a specified resource provider.",
- "parameters": [
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns resource types information for the resource provider.",
- "schema": {
- "$ref": "#/definitions/ProviderResourceTypeListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Get provider resource types.": {
- "$ref": "./examples/GetProviderResourceTypes.json"
- }
- }
- }
- },
- "/providers/{resourceProviderNamespace}": {
- "get": {
- "tags": [
- "Providers"
- ],
- "x-ms-examples": {
- "Get a resource provider at tenant scope": {
- "$ref": "./examples/GetNamedProviderAtTenant.json"
- }
- },
- "operationId": "Providers_GetAtTenantScope",
- "description": "Gets the specified resource provider at the tenant level.",
- "parameters": [
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases."
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource provider.",
- "schema": {
- "$ref": "#/definitions/Provider"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": {
- "get": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "Resources_ListByResourceGroup",
- "description": "Get all the resources for a resource group.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource group with the resources to get.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
- },
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return. If null is passed, returns all resources."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of resources",
- "schema": {
- "$ref": "#/definitions/ResourceListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/GenericResourceFilter"
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": {
- "head": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_CheckExistence",
- "description": "Checks whether a resource group exists.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to check. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "ResourceGroups"
- ],
- "x-ms-examples": {
- "Create or update a resource group": {
- "$ref": "./examples/CreateResourceGroup.json"
- }
- },
- "operationId": "ResourceGroups_CreateOrUpdate",
- "description": "Creates or updates a resource group.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ResourceGroup"
- },
- "description": "Parameters supplied to the create or update a resource group."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the new resource group.",
- "schema": {
- "$ref": "#/definitions/ResourceGroup"
- }
- },
- "201": {
- "description": "Created - Returns information about the new resource group.",
- "schema": {
- "$ref": "#/definitions/ResourceGroup"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "delete": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_Delete",
- "summary": "Deletes a resource group.",
- "description": "When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to delete. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "forceDeletionTypes",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "x-ms-examples": {
- "Force delete all the Virtual Machines in a resource group": {
- "$ref": "./examples/ForceDeleteVMsInResourceGroup.json"
- },
- "Force delete all the Virtual Machines and Virtual Machine Scale Sets in a resource group": {
- "$ref": "./examples/ForceDeleteVMsAndVMSSInResourceGroup.json"
- }
- },
- "responses": {
- "200": {
- "description": "OK"
- },
- "202": {
- "description": "Accepted"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "get": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_Get",
- "description": "Gets a resource group.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to get. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource group.",
- "schema": {
- "$ref": "#/definitions/ResourceGroup"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "patch": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_Update",
- "summary": "Updates a resource group.",
- "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group to update. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ResourceGroupPatchable"
- },
- "description": "Parameters supplied to update a resource group."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource group.",
- "schema": {
- "$ref": "#/definitions/ResourceGroup"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": {
- "post": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_ExportTemplate",
- "description": "Captures the specified resource group as a template.",
- "parameters": [
- {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter"
- },
- {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ExportTemplateRequest"
- },
- "description": "Parameters for exporting the template."
- }
- ],
- "x-ms-examples": {
- "Export a resource group": {
- "$ref": "./examples/ExportResourceGroup.json"
- },
- "Export a resource group with filtering": {
- "$ref": "./examples/ExportResourceGroupWithFiltering.json"
- }
- },
- "responses": {
- "200": {
- "description": "OK - Returns the result of the export.",
- "schema": {
- "$ref": "#/definitions/ResourceGroupExportResult"
- }
- },
- "202": {
- "description": "Accepted"
- },
- "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"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups": {
- "get": {
- "tags": [
- "ResourceGroups"
- ],
- "operationId": "ResourceGroups_List",
- "description": "Gets all the resource groups for a subscription.",
- "parameters": [
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return. If null is passed, returns all resource groups."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of resource groups.",
- "schema": {
- "$ref": "#/definitions/ResourceGroupListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/ResourceGroupFilter"
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": {
- "post": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_MoveResources",
- "summary": "Moves resources from one resource group to another resource group.",
- "description": "The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ",
- "parameters": [
- {
- "name": "sourceResourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group containing the resources to move.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ResourcesMoveInfo"
- },
- "description": "Parameters for moving resources."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- }
- },
- "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources": {
- "post": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_ValidateMoveResources",
- "summary": "Validates whether resources can be moved from one resource group to another resource group.",
- "description": "This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.",
- "parameters": [
- {
- "name": "sourceResourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group containing the resources to validate for move.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ResourcesMoveInfo"
- },
- "description": "Parameters for moving resources."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- }
- },
- "/subscriptions/{subscriptionId}/resources": {
- "get": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_List",
- "description": "Get all the resources in a subscription.",
- "parameters": [
- {
- "name": "$filter",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "The filter to apply on the operation.
The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.
For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'
You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.
For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)
You can link more than one substringof together by adding and/or operators.
You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.
You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId."
- },
- {
- "name": "$expand",
- "in": "query",
- "required": false,
- "type": "string",
- "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return. If null is passed, returns all resources."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of resources.",
- "schema": {
- "$ref": "#/definitions/ResourceListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- },
- "x-ms-odata": "#/definitions/GenericResourceFilter"
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": {
- "head": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_CheckExistence",
- "description": "Checks whether a resource exists.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group containing the resource to check. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource provider of the resource to check."
- },
- {
- "name": "parentResourcePath",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The parent resource identity.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceType",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource type.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource to check whether it exists."
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "delete": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_Delete",
- "description": "Deletes a resource.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group that contains the resource to delete. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "name": "parentResourcePath",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The parent resource identity.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceType",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource type.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource to delete."
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "put": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_CreateOrUpdate",
- "description": "Creates a resource.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group for the resource. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "name": "parentResourcePath",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The parent resource identity.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceType",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource type of the resource to create.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource to create."
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/GenericResource"
- },
- "description": "Parameters for creating or updating the resource."
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "201": {
- "description": "Created - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "202": {
- "description": "Accepted"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "patch": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_Update",
- "description": "Updates a resource.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group for the resource. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "name": "parentResourcePath",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The parent resource identity.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceType",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource type of the resource to update.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource to update."
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/GenericResource"
- },
- "description": "Parameters for updating the resource."
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "202": {
- "description": "Accepted"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "get": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_Get",
- "description": "Gets a resource.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group containing the resource to get. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "name": "resourceProviderNamespace",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- {
- "name": "parentResourcePath",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The parent resource identity.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceType",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource type of the resource.",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "resourceName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource to get."
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{resourceId}": {
- "head": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_CheckExistenceById",
- "description": "Checks by ID whether a resource exists.",
- "parameters": [
- {
- "name": "resourceId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- }
- ],
- "responses": {
- "204": {
- "description": "No Content"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "delete": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_DeleteById",
- "description": "Deletes a resource by ID.",
- "parameters": [
- {
- "name": "resourceId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "202": {
- "description": "Accepted"
- },
- "204": {
- "description": "No Content"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "put": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_CreateOrUpdateById",
- "description": "Create a resource by ID.",
- "parameters": [
- {
- "name": "resourceId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/GenericResource"
- },
- "description": "Create or update resource parameters."
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "201": {
- "description": "Created - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "202": {
- "description": "Accepted"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "patch": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_UpdateById",
- "description": "Updates a resource by ID.",
- "parameters": [
- {
- "name": "resourceId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/GenericResource"
- },
- "description": "Update resource parameters."
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "202": {
- "description": "Accepted"
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-long-running-operation": true
- },
- "get": {
- "tags": [
- "Resources"
- ],
- "operationId": "Resources_GetById",
- "description": "Gets a resource by ID.",
- "parameters": [
- {
- "name": "resourceId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}",
- "x-ms-skip-url-encoding": true
- },
- {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-api-version": false
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the resource.",
- "schema": {
- "$ref": "#/definitions/GenericResource"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": {
- "delete": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_DeleteValue",
- "summary": "Deletes a predefined tag value for a predefined tag name.",
- "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.",
- "parameters": [
- {
- "name": "tagName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the tag."
- },
- {
- "name": "tagValue",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The value of the tag to delete."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Predefined tag value successfully deleted."
- },
- "204": {
- "description": "Predefined tag value did not exist."
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "put": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_CreateOrUpdateValue",
- "summary": "Creates a predefined value for a predefined tag name.",
- "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.",
- "parameters": [
- {
- "name": "tagName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the tag."
- },
- {
- "name": "tagValue",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The value of the tag to create."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Predefined tag value already exists. Returns information about the predefined tag value.",
- "schema": {
- "$ref": "#/definitions/TagValue"
- }
- },
- "201": {
- "description": "Predefined tag value successfully created. Returns information about the predefined tag value.",
- "schema": {
- "$ref": "#/definitions/TagValue"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/tagNames/{tagName}": {
- "put": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_CreateOrUpdate",
- "summary": "Creates a predefined tag name.",
- "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.",
- "parameters": [
- {
- "name": "tagName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the tag to create."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Predefined tag name already exists. Returns information about the predefined tag name.",
- "schema": {
- "$ref": "#/definitions/TagDetails"
- }
- },
- "201": {
- "description": "Predefined tag name successfully created. Returns information about the predefined tag name.",
- "schema": {
- "$ref": "#/definitions/TagDetails"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "delete": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_Delete",
- "summary": "Deletes a predefined tag name.",
- "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.",
- "parameters": [
- {
- "name": "tagName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the tag."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Predefined tag name successfully deleted."
- },
- "204": {
- "description": "Predefined tag name did not exist."
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/tagNames": {
- "get": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_List",
- "summary": "Gets a summary of tag usage under the subscription.",
- "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.",
- "parameters": [
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns an array of tag names and values.",
- "schema": {
- "$ref": "#/definitions/TagsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_GetAtScope",
- "description": "Gets a deployments operation.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "operationId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the operation to get."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment operation.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperation"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_ListAtScope",
- "description": "Gets all deployments operations for a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Return an array of deployment operations.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperationsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_GetAtTenantScope",
- "description": "Gets a deployments operation.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "operationId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the operation to get."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment operation.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperation"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_ListAtTenantScope",
- "description": "Gets all deployments operations for a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Return an array of deployment operations.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperationsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_GetAtManagementGroupScope",
- "description": "Gets a deployments operation.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "operationId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the operation to get."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment operation.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperation"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_ListAtManagementGroupScope",
- "description": "Gets all deployments operations for a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/GroupIdParameter"
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Return an array of deployment operations.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperationsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_GetAtSubscriptionScope",
- "description": "Gets a deployments operation.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "operationId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the operation to get."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment operation.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperation"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_ListAtSubscriptionScope",
- "description": "Gets all deployments operations for a deployment.",
- "parameters": [
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Return an array of deployment operations.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperationsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_Get",
- "description": "Gets a deployments operation.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "operationId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the operation to get."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Returns information about the deployment operation.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperation"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": {
- "get": {
- "tags": [
- "DeploymentOperations"
- ],
- "operationId": "DeploymentOperations_List",
- "description": "Gets all deployments operations for a deployment.",
- "parameters": [
- {
- "name": "resourceGroupName",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The name of the resource group. The name is case insensitive.",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "minLength": 1,
- "maxLength": 90
- },
- {
- "$ref": "#/parameters/DeploymentNameParameter"
- },
- {
- "name": "$top",
- "in": "query",
- "required": false,
- "type": "integer",
- "format": "int32",
- "description": "The number of results to return."
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "$ref": "#/parameters/SubscriptionIdParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "OK - Return an array of deployment operations.",
- "schema": {
- "$ref": "#/definitions/DeploymentOperationsListResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-pageable": {
- "nextLinkName": "nextLink"
- }
- }
- },
- "/providers/Microsoft.Resources/calculateTemplateHash": {
- "post": {
- "tags": [
- "Deployments"
- ],
- "operationId": "Deployments_CalculateTemplateHash",
- "description": "Calculate the hash of the given template.",
- "parameters": [
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "name": "template",
- "in": "body",
- "required": true,
- "schema": {
- "type": "object"
- },
- "description": "The template provided to calculate hash."
- }
- ],
- "x-ms-examples": {
- "Calculate template hash": {
- "$ref": "./examples/CalculateTemplateHash.json"
- }
- },
- "responses": {
- "200": {
- "description": "OK - Returns the hash.",
- "schema": {
- "$ref": "#/definitions/TemplateHashResult"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- },
- "/{scope}/providers/Microsoft.Resources/tags/default": {
- "put": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_CreateOrUpdateAtScope",
- "summary": "Creates or updates the entire set of tags on a resource or subscription.",
- "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/TagsResource"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Tags updated successfully. Returns tags from the specified object.",
- "schema": {
- "$ref": "#/definitions/TagsResource"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Update tags on a resource": {
- "$ref": "./examples/PutTagsResource.json"
- },
- "Update tags on a subscription": {
- "$ref": "./examples/PutTagsSubscription.json"
- }
- }
- },
- "patch": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_UpdateAtScope",
- "summary": "Selectively updates the set of tags on a resource or subscription.",
- "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- },
- {
- "name": "parameters",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/TagsPatchResource"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Tags updated successfully. Returns tags from the specified object.",
- "schema": {
- "$ref": "#/definitions/TagsResource"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- },
- "get": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_GetAtScope",
- "summary": "Gets the entire set of tags on a resource or subscription.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Returns tags from the specified object.",
- "schema": {
- "$ref": "#/definitions/TagsResource"
- }
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- },
- "x-ms-examples": {
- "Get tags on a resource": {
- "$ref": "./examples/GetTagsResource.json"
- },
- "Get tags on a subscription": {
- "$ref": "./examples/GetTagsSubscription.json"
- }
- }
- },
- "delete": {
- "tags": [
- "Tags"
- ],
- "operationId": "Tags_DeleteAtScope",
- "summary": "Deletes the entire set of tags on a resource or subscription.",
- "parameters": [
- {
- "$ref": "#/parameters/ScopeParameter"
- },
- {
- "$ref": "#/parameters/ApiVersionParameter"
- }
- ],
- "responses": {
- "200": {
- "description": "Tags successfully deleted."
- },
- "default": {
- "description": "Error response describing why the operation failed.",
- "schema": {
- "$ref": "#/definitions/CloudError"
- }
- }
- }
- }
- }
- },
- "definitions": {
- "DeploymentExtendedFilter": {
- "properties": {
- "provisioningState": {
- "type": "string",
- "description": "The provisioning state."
- }
- },
- "description": "Deployment filter."
- },
- "GenericResourceFilter": {
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "The resource type."
- },
- "tagname": {
- "type": "string",
- "description": "The tag name."
- },
- "tagvalue": {
- "type": "string",
- "description": "The tag value."
- }
- },
- "description": "Resource filter."
- },
- "ResourceGroupFilter": {
- "properties": {
- "tagName": {
- "type": "string",
- "description": "The tag name."
- },
- "tagValue": {
- "type": "string",
- "description": "The tag value."
- }
- },
- "description": "Resource group filter."
- },
- "TemplateLink": {
- "properties": {
- "uri": {
- "type": "string",
- "description": "The URI of the template to deploy. Use either the uri or id property, but not both."
- },
- "id": {
- "type": "string",
- "description": "The resource id of a Template Spec. Use either the id or uri property, but not both."
- },
- "relativePath": {
- "type": "string",
- "description": "The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs"
- },
- "contentVersion": {
- "type": "string",
- "description": "If included, must match the ContentVersion in the template."
- },
- "queryString": {
- "type": "string",
- "description": "The query string (for example, a SAS token) to be used with the templateLink URI."
- }
- },
- "description": "Entity representing the reference to the template."
- },
- "ParametersLink": {
- "properties": {
- "uri": {
- "type": "string",
- "description": "The URI of the parameters file."
- },
- "contentVersion": {
- "type": "string",
- "description": "If included, must match the ContentVersion in the template."
- }
- },
- "required": [
- "uri"
- ],
- "description": "Entity representing the reference to the deployment parameters."
- },
- "DeploymentProperties": {
- "properties": {
- "template": {
- "type": "object",
- "description": "The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both."
- },
- "templateLink": {
- "$ref": "#/definitions/TemplateLink",
- "description": "The URI of the template. Use either the templateLink property or the template property, but not both."
- },
- "parameters": {
- "type": "object",
- "description": "Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string."
- },
- "parametersLink": {
- "$ref": "#/definitions/ParametersLink",
- "description": "The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both."
- },
- "mode": {
- "type": "string",
- "description": "The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.",
- "enum": [
- "Incremental",
- "Complete"
- ],
- "x-ms-enum": {
- "name": "DeploymentMode",
- "modelAsString": false
- }
- },
- "debugSetting": {
- "$ref": "#/definitions/DebugSetting",
- "description": "The debug setting of the deployment."
- },
- "onErrorDeployment": {
- "$ref": "#/definitions/OnErrorDeployment",
- "description": "The deployment on error behavior."
- },
- "expressionEvaluationOptions": {
- "$ref": "#/definitions/ExpressionEvaluationOptions",
- "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer."
- }
- },
- "required": [
- "mode"
- ],
- "description": "Deployment properties."
- },
- "DebugSetting": {
- "properties": {
- "detailLevel": {
- "type": "string",
- "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations."
- }
- },
- "description": "The debug setting."
- },
- "Deployment": {
- "properties": {
- "location": {
- "type": "string",
- "description": "The location to store the deployment data."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentProperties",
- "description": "The deployment properties."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Deployment tags"
- }
- },
- "required": [
- "properties"
- ],
- "description": "Deployment operation parameters."
- },
- "ScopedDeployment": {
- "properties": {
- "location": {
- "type": "string",
- "description": "The location to store the deployment data."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentProperties",
- "description": "The deployment properties."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Deployment tags"
- }
- },
- "required": [
- "location",
- "properties"
- ],
- "description": "Deployment operation parameters."
- },
- "DeploymentExportResult": {
- "properties": {
- "template": {
- "type": "object",
- "description": "The template content."
- }
- },
- "description": "The deployment export result. "
- },
- "DeploymentWhatIf": {
- "properties": {
- "location": {
- "type": "string",
- "description": "The location to store the deployment data."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentWhatIfProperties",
- "description": "The deployment properties."
- }
- },
- "required": [
- "properties"
- ],
- "description": "Deployment What-if operation parameters."
- },
- "ScopedDeploymentWhatIf": {
- "properties": {
- "location": {
- "type": "string",
- "description": "The location to store the deployment data."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentWhatIfProperties",
- "description": "The deployment properties."
- }
- },
- "required": [
- "location",
- "properties"
- ],
- "description": "Deployment What-if operation parameters."
- },
- "DeploymentWhatIfProperties": {
- "properties": {
- "whatIfSettings": {
- "$ref": "#/definitions/DeploymentWhatIfSettings",
- "description": "Optional What-If operation settings."
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/DeploymentProperties"
- }
- ],
- "description": "Deployment What-if properties."
- },
- "DeploymentWhatIfSettings": {
- "properties": {
- "resultFormat": {
- "type": "string",
- "description": "The format of the What-If results",
- "enum": [
- "ResourceIdOnly",
- "FullResourcePayloads"
- ],
- "x-ms-enum": {
- "name": "WhatIfResultFormat",
- "modelAsString": false
- }
- }
- },
- "description": "Deployment What-If operation settings."
- },
- "CloudError": {
- "x-ms-external": true,
- "properties": {
- "error": {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse"
- }
- },
- "description": "An error response for a resource management request."
- },
- "ApiProfile": {
- "properties": {
- "profileVersion": {
- "type": "string",
- "readOnly": true,
- "description": "The profile version."
- },
- "apiVersion": {
- "type": "string",
- "readOnly": true,
- "description": "The API version."
- }
- }
- },
- "AliasPathMetadata": {
- "properties": {
- "type": {
- "type": "string",
- "readOnly": true,
- "enum": [
- "NotSpecified",
- "Any",
- "String",
- "Object",
- "Array",
- "Integer",
- "Number",
- "Boolean"
- ],
- "x-ms-enum": {
- "name": "AliasPathTokenType",
- "modelAsString": true,
- "values": [
- {
- "value": "NotSpecified",
- "description": "The token type is not specified."
- },
- {
- "value": "Any",
- "description": "The token type can be anything."
- },
- {
- "value": "String",
- "description": "The token type is string."
- },
- {
- "value": "Object",
- "description": "The token type is object."
- },
- {
- "value": "Array",
- "description": "The token type is array."
- },
- {
- "value": "Integer",
- "description": "The token type is integer."
- },
- {
- "value": "Number",
- "description": "The token type is number."
- },
- {
- "value": "Boolean",
- "description": "The token type is boolean."
- }
- ]
- },
- "description": "The type of the token that the alias path is referring to."
- },
- "attributes": {
- "type": "string",
- "readOnly": true,
- "enum": [
- "None",
- "Modifiable"
- ],
- "x-ms-enum": {
- "name": "AliasPathAttributes",
- "modelAsString": true,
- "values": [
- {
- "value": "None",
- "description": "The token that the alias path is referring to has no attributes."
- },
- {
- "value": "Modifiable",
- "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect."
- }
- ]
- },
- "description": "The attributes of the token that the alias path is referring to."
- }
- }
- },
- "AliasPath": {
- "properties": {
- "path": {
- "type": "string",
- "description": "The path of an alias."
- },
- "apiVersions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The API versions."
- },
- "pattern": {
- "$ref": "#/definitions/AliasPattern",
- "description": "The pattern for an alias path."
- },
- "metadata": {
- "readOnly": true,
- "$ref": "#/definitions/AliasPathMetadata",
- "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias."
- }
- },
- "description": "The type of the paths for alias."
- },
- "AliasPattern": {
- "properties": {
- "phrase": {
- "type": "string",
- "description": "The alias pattern phrase."
- },
- "variable": {
- "type": "string",
- "description": "The alias pattern variable."
- },
- "type": {
- "type": "string",
- "enum": [
- "NotSpecified",
- "Extract"
- ],
- "x-ms-enum": {
- "name": "AliasPatternType",
- "modelAsString": false,
- "values": [
- {
- "value": "NotSpecified",
- "description": "NotSpecified is not allowed."
- },
- {
- "value": "Extract",
- "description": "Extract is the only allowed value."
- }
- ]
- },
- "description": "The type of alias pattern"
- }
- },
- "description": "The type of the pattern for an alias path."
- },
- "Alias": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The alias name."
- },
- "paths": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AliasPath"
- },
- "description": "The paths for an alias."
- },
- "type": {
- "type": "string",
- "description": "The type of the alias.",
- "enum": [
- "NotSpecified",
- "PlainText",
- "Mask"
- ],
- "x-ms-enum": {
- "name": "AliasType",
- "modelAsString": false,
- "values": [
- {
- "value": "NotSpecified",
- "description": "Alias type is unknown (same as not providing alias type)."
- },
- {
- "value": "PlainText",
- "description": "Alias value is not secret."
- },
- {
- "value": "Mask",
- "description": "Alias value is secret."
- }
- ]
- }
- },
- "defaultPath": {
- "type": "string",
- "description": "The default path for an alias."
- },
- "defaultPattern": {
- "$ref": "#/definitions/AliasPattern",
- "description": "The default pattern for an alias."
- },
- "defaultMetadata": {
- "readOnly": true,
- "$ref": "#/definitions/AliasPathMetadata",
- "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata"
- }
- },
- "description": "The alias type. "
- },
- "ProviderExtendedLocation": {
- "properties": {
- "location": {
- "type": "string",
- "description": "The azure location."
- },
- "type": {
- "type": "string",
- "description": "The extended location type."
- },
- "extendedLocations": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The extended locations for the azure location."
- }
- },
- "description": "The provider extended location. "
- },
- "ProviderResourceType": {
- "properties": {
- "resourceType": {
- "type": "string",
- "description": "The resource type."
- },
- "locations": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The collection of locations where this resource type can be created."
- },
- "locationMappings": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ProviderExtendedLocation"
- },
- "description": "The location mappings that are supported by this resource type."
- },
- "aliases": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Alias"
- },
- "description": "The aliases that are supported by this resource type."
- },
- "apiVersions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The API version."
- },
- "defaultApiVersion": {
- "type": "string",
- "readOnly": true,
- "description": "The default API version."
- },
- "zoneMappings": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ZoneMapping"
- }
- },
- "apiProfiles": {
- "type": "array",
- "readOnly": true,
- "items": {
- "$ref": "#/definitions/ApiProfile"
- },
- "description": "The API profiles for the resource provider."
- },
- "capabilities": {
- "type": "string",
- "description": "The additional capabilities offered by this resource type."
- },
- "properties": {
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "description": "The additional properties. "
- },
- "description": "The properties."
- }
- },
- "description": "Resource type managed by the resource provider."
- },
- "Provider": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The provider ID."
- },
- "namespace": {
- "type": "string",
- "description": "The namespace of the resource provider."
- },
- "registrationState": {
- "readOnly": true,
- "type": "string",
- "description": "The registration state of the resource provider."
- },
- "registrationPolicy": {
- "readOnly": true,
- "type": "string",
- "description": "The registration policy of the resource provider."
- },
- "resourceTypes": {
- "readOnly": true,
- "type": "array",
- "items": {
- "$ref": "#/definitions/ProviderResourceType"
- },
- "description": "The collection of provider resource types."
- }
- },
- "description": "Resource provider information."
- },
- "BasicDependency": {
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the dependency."
- },
- "resourceType": {
- "type": "string",
- "description": "The dependency resource type."
- },
- "resourceName": {
- "type": "string",
- "description": "The dependency resource name."
- }
- },
- "description": "Deployment dependency information."
- },
- "Dependency": {
- "properties": {
- "dependsOn": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/BasicDependency"
- },
- "description": "The list of dependencies."
- },
- "id": {
- "type": "string",
- "description": "The ID of the dependency."
- },
- "resourceType": {
- "type": "string",
- "description": "The dependency resource type."
- },
- "resourceName": {
- "type": "string",
- "description": "The dependency resource name."
- }
- },
- "description": "Deployment dependency information."
- },
- "DeploymentPropertiesExtended": {
- "properties": {
- "provisioningState": {
- "type": "string",
- "readOnly": true,
- "description": "Denotes the state of provisioning.",
- "enum": [
- "NotSpecified",
- "Accepted",
- "Running",
- "Ready",
- "Creating",
- "Created",
- "Deleting",
- "Deleted",
- "Canceled",
- "Failed",
- "Succeeded",
- "Updating"
- ],
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": true
- }
- },
- "correlationId": {
- "readOnly": true,
- "type": "string",
- "description": "The correlation ID of the deployment."
- },
- "timestamp": {
- "readOnly": true,
- "type": "string",
- "format": "date-time",
- "description": "The timestamp of the template deployment."
- },
- "duration": {
- "readOnly": true,
- "type": "string",
- "description": "The duration of the template deployment."
- },
- "outputs": {
- "readOnly": true,
- "type": "object",
- "description": "Key/value pairs that represent deployment output."
- },
- "providers": {
- "readOnly": true,
- "type": "array",
- "items": {
- "$ref": "#/definitions/Provider"
- },
- "description": "The list of resource providers needed for the deployment."
- },
- "dependencies": {
- "readOnly": true,
- "type": "array",
- "items": {
- "$ref": "#/definitions/Dependency"
- },
- "description": "The list of deployment dependencies."
- },
- "templateLink": {
- "readOnly": true,
- "$ref": "#/definitions/TemplateLink",
- "description": "The URI referencing the template."
- },
- "parameters": {
- "readOnly": true,
- "type": "object",
- "description": "Deployment parameters. "
- },
- "parametersLink": {
- "readOnly": true,
- "$ref": "#/definitions/ParametersLink",
- "description": "The URI referencing the parameters. "
- },
- "mode": {
- "readOnly": true,
- "type": "string",
- "description": "The deployment mode. Possible values are Incremental and Complete.",
- "enum": [
- "Incremental",
- "Complete"
- ],
- "x-ms-enum": {
- "name": "DeploymentMode",
- "modelAsString": false
- }
- },
- "debugSetting": {
- "readOnly": true,
- "$ref": "#/definitions/DebugSetting",
- "description": "The debug setting of the deployment."
- },
- "onErrorDeployment": {
- "readOnly": true,
- "$ref": "#/definitions/OnErrorDeploymentExtended",
- "description": "The deployment on error behavior."
- },
- "templateHash": {
- "readOnly": true,
- "type": "string",
- "description": "The hash produced for the template."
- },
- "outputResources": {
- "readOnly": true,
- "type": "array",
- "description": "Array of provisioned resources.",
- "items": {
- "$ref": "#/definitions/ResourceReference",
- "description": "Details of provisioned resources."
- }
- },
- "validatedResources": {
- "readOnly": true,
- "type": "array",
- "description": "Array of validated resources.",
- "items": {
- "$ref": "#/definitions/ResourceReference",
- "description": "Details of validated resources."
- }
- },
- "error": {
- "readOnly": true,
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
- "description": "The deployment error."
- }
- },
- "description": "Deployment properties with additional details."
- },
- "ResourceReference": {
- "description": "The resource Id model.",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The fully qualified resource Id."
- }
- }
- },
- "OnErrorDeployment": {
- "properties": {
- "type": {
- "type": "string",
- "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
- "enum": [
- "LastSuccessful",
- "SpecificDeployment"
- ],
- "x-ms-enum": {
- "name": "OnErrorDeploymentType",
- "modelAsString": false
- }
- },
- "deploymentName": {
- "type": "string",
- "description": "The deployment to be used on error case."
- }
- },
- "description": "Deployment on error behavior."
- },
- "OnErrorDeploymentExtended": {
- "properties": {
- "provisioningState": {
- "readOnly": true,
- "type": "string",
- "description": "The state of the provisioning for the on error deployment."
- },
- "type": {
- "type": "string",
- "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.",
- "enum": [
- "LastSuccessful",
- "SpecificDeployment"
- ],
- "x-ms-enum": {
- "name": "OnErrorDeploymentType",
- "modelAsString": false
- }
- },
- "deploymentName": {
- "type": "string",
- "description": "The deployment to be used on error case."
- }
- },
- "description": "Deployment on error behavior with additional details."
- },
- "DeploymentValidateResult": {
- "properties": {
- "error": {
- "readOnly": true,
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
- "description": "The deployment validation error."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentPropertiesExtended",
- "description": "The template deployment properties."
- }
- },
- "description": "Information from validate template deployment response."
- },
- "DeploymentExtended": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The ID of the deployment."
- },
- "name": {
- "readOnly": true,
- "type": "string",
- "description": "The name of the deployment."
- },
- "type": {
- "readOnly": true,
- "type": "string",
- "description": "The type of the deployment."
- },
- "location": {
- "type": "string",
- "description": "the location of the deployment."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentPropertiesExtended",
- "description": "Deployment properties."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Deployment tags"
- }
- },
- "x-ms-azure-resource": true,
- "description": "Deployment information."
- },
- "DeploymentListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/DeploymentExtended"
- },
- "description": "An array of deployments."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of deployments."
- },
- "ProviderListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Provider"
- },
- "description": "An array of resource providers."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of resource providers."
- },
- "ProviderResourceTypeListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ProviderResourceType"
- },
- "description": "An array of resource types."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of resource types of a resource provider."
- },
- "GenericResource": {
- "properties": {
- "plan": {
- "$ref": "#/definitions/Plan",
- "description": "The plan of the resource."
- },
- "properties": {
- "type": "object",
- "description": "The resource properties."
- },
- "kind": {
- "type": "string",
- "description": "The kind of the resource.",
- "pattern": "^[-\\w\\._,\\(\\)]+$"
- },
- "managedBy": {
- "type": "string",
- "description": "ID of the resource that manages this resource."
- },
- "sku": {
- "$ref": "#/definitions/Sku",
- "description": "The SKU of the resource."
- },
- "identity": {
- "$ref": "#/definitions/Identity",
- "description": "The identity of the resource."
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "description": "Resource information."
- },
- "ExtendedLocation": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "EdgeZone"
- ],
- "x-ms-enum": {
- "name": "ExtendedLocationType",
- "modelAsString": true
- },
- "description": "The extended location type."
- },
- "name": {
- "type": "string",
- "description": "The extended location name."
- }
- },
- "description": "Resource extended location."
- },
- "GenericResourceExpanded": {
- "properties": {
- "createdTime": {
- "readOnly": true,
- "type": "string",
- "format": "date-time",
- "description": "The created time of the resource. This is only present if requested via the $expand query parameter."
- },
- "changedTime": {
- "readOnly": true,
- "type": "string",
- "format": "date-time",
- "description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
- },
- "provisioningState": {
- "readOnly": true,
- "type": "string",
- "description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
- }
- },
- "allOf": [
- {
- "$ref": "#/definitions/GenericResource"
- }
- ],
- "description": "Resource information."
- },
- "Plan": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The plan ID."
- },
- "publisher": {
- "type": "string",
- "description": "The publisher ID."
- },
- "product": {
- "type": "string",
- "description": "The offer ID."
- },
- "promotionCode": {
- "type": "string",
- "description": "The promotion code."
- },
- "version": {
- "type": "string",
- "description": "The plan's version."
- }
- },
- "description": "Plan for the resource."
- },
- "Sku": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The SKU name."
- },
- "tier": {
- "type": "string",
- "description": "The SKU tier."
- },
- "size": {
- "type": "string",
- "description": "The SKU size."
- },
- "family": {
- "type": "string",
- "description": "The SKU family."
- },
- "model": {
- "type": "string",
- "description": "The SKU model."
- },
- "capacity": {
- "type": "integer",
- "format": "int32",
- "description": "The SKU capacity."
- }
- },
- "description": "SKU for the resource."
- },
- "Identity": {
- "properties": {
- "principalId": {
- "readOnly": true,
- "type": "string",
- "description": "The principal ID of resource identity."
- },
- "tenantId": {
- "readOnly": true,
- "type": "string",
- "description": "The tenant ID of resource."
- },
- "type": {
- "type": "string",
- "description": "The identity type.",
- "enum": [
- "SystemAssigned",
- "UserAssigned",
- "SystemAssigned, UserAssigned",
- "None"
- ],
- "x-ms-enum": {
- "name": "ResourceIdentityType",
- "modelAsString": false
- }
- },
- "userAssignedIdentities": {
- "type": "object",
- "additionalProperties": {
- "type": "object",
- "x-ms-client-name": "IdentityUserAssignedIdentitiesValue",
- "properties": {
- "principalId": {
- "readOnly": true,
- "type": "string",
- "description": "The principal id of user assigned identity."
- },
- "clientId": {
- "readOnly": true,
- "type": "string",
- "description": "The client id of user assigned identity."
- }
- }
- },
- "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
- }
- },
- "description": "Identity for the resource."
- },
- "ResourceListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GenericResourceExpanded"
- },
- "description": "An array of resources."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of resource groups."
- },
- "ResourceGroup": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The ID of the resource group."
- },
- "name": {
- "readOnly": true,
- "type": "string",
- "description": "The name of the resource group."
- },
- "type": {
- "readOnly": true,
- "type": "string",
- "description": "The type of the resource group."
- },
- "properties": {
- "$ref": "#/definitions/ResourceGroupProperties",
- "description": "The resource group properties."
- },
- "location": {
- "type": "string",
- "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations."
- },
- "managedBy": {
- "type": "string",
- "description": "The ID of the resource that manages this resource group."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "description": "The additional properties. "
- },
- "description": "The tags attached to the resource group."
- }
- },
- "required": [
- "location"
- ],
- "x-ms-azure-resource": true,
- "description": "Resource group information."
- },
- "ResourceGroupPatchable": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of the resource group."
- },
- "properties": {
- "$ref": "#/definitions/ResourceGroupProperties",
- "description": "The resource group properties."
- },
- "managedBy": {
- "type": "string",
- "description": "The ID of the resource that manages this resource group."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "description": "The additional properties. "
- },
- "description": "The tags attached to the resource group."
- }
- },
- "description": "Resource group information."
- },
- "ResourceGroupProperties": {
- "properties": {
- "provisioningState": {
- "readOnly": true,
- "type": "string",
- "description": "The provisioning state. "
- }
- },
- "description": "The resource group properties."
- },
- "ResourceGroupListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceGroup"
- },
- "description": "An array of resource groups."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of resource groups."
- },
- "ResourcesMoveInfo": {
- "properties": {
- "resources": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The IDs of the resources."
- },
- "targetResourceGroup": {
- "type": "string",
- "description": "The target resource group."
- }
- },
- "description": "Parameters of move resources."
- },
- "ExportTemplateRequest": {
- "properties": {
- "resources": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'."
- },
- "options": {
- "type": "string",
- "description": "The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'"
- }
- },
- "description": "Export resource group template request parameters."
- },
- "TagCount": {
- "properties": {
- "type": {
- "type": "string",
- "description": "Type of count."
- },
- "value": {
- "type": "integer",
- "description": "Value of count."
- }
- },
- "description": "Tag count."
- },
- "TagValue": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The tag value ID."
- },
- "tagValue": {
- "type": "string",
- "description": "The tag value."
- },
- "count": {
- "$ref": "#/definitions/TagCount",
- "description": "The tag value count."
- }
- },
- "x-ms-azure-resource": true,
- "description": "Tag information."
- },
- "TagDetails": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The tag name ID."
- },
- "tagName": {
- "type": "string",
- "description": "The tag name."
- },
- "count": {
- "$ref": "#/definitions/TagCount",
- "description": "The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0."
- },
- "values": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TagValue"
- },
- "description": "The list of tag values."
- }
- },
- "x-ms-azure-resource": true,
- "description": "Tag details."
- },
- "TagsListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TagDetails"
- },
- "description": "An array of tags."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of subscription tags."
- },
- "TargetResource": {
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the resource."
- },
- "resourceName": {
- "type": "string",
- "description": "The name of the resource."
- },
- "resourceType": {
- "type": "string",
- "description": "The type of the resource."
- }
- },
- "description": "Target resource."
- },
- "HttpMessage": {
- "properties": {
- "content": {
- "type": "object",
- "description": "HTTP message content."
- }
- },
- "description": "HTTP message."
- },
- "DeploymentOperationProperties": {
- "properties": {
- "provisioningOperation": {
- "readOnly": true,
- "type": "string",
- "description": "The name of the current provisioning operation.",
- "enum": [
- "NotSpecified",
- "Create",
- "Delete",
- "Waiting",
- "AzureAsyncOperationWaiting",
- "ResourceCacheWaiting",
- "Action",
- "Read",
- "EvaluateDeploymentOutput",
- "DeploymentCleanup"
- ],
- "x-ms-enum": {
- "name": "ProvisioningOperation",
- "modelAsString": false,
- "values": [
- {
- "value": "NotSpecified",
- "description": "The provisioning operation is not specified."
- },
- {
- "value": "Create",
- "description": "The provisioning operation is create."
- },
- {
- "value": "Delete",
- "description": "The provisioning operation is delete."
- },
- {
- "value": "Waiting",
- "description": "The provisioning operation is waiting."
- },
- {
- "value": "AzureAsyncOperationWaiting",
- "description": "The provisioning operation is waiting Azure async operation."
- },
- {
- "value": "ResourceCacheWaiting",
- "description": "The provisioning operation is waiting for resource cache."
- },
- {
- "value": "Action",
- "description": "The provisioning operation is action."
- },
- {
- "value": "Read",
- "description": "The provisioning operation is read."
- },
- {
- "value": "EvaluateDeploymentOutput",
- "description": "The provisioning operation is evaluate output."
- },
- {
- "value": "DeploymentCleanup",
- "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment."
- }
- ]
- }
- },
- "provisioningState": {
- "readOnly": true,
- "type": "string",
- "description": "The state of the provisioning."
- },
- "timestamp": {
- "readOnly": true,
- "type": "string",
- "format": "date-time",
- "description": "The date and time of the operation."
- },
- "duration": {
- "readOnly": true,
- "type": "string",
- "description": "The duration of the operation."
- },
- "serviceRequestId": {
- "readOnly": true,
- "type": "string",
- "description": "Deployment operation service request id."
- },
- "statusCode": {
- "readOnly": true,
- "type": "string",
- "description": "Operation status code from the resource provider. This property may not be set if a response has not yet been received."
- },
- "statusMessage": {
- "readOnly": true,
- "description": "Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider.",
- "$ref": "#/definitions/StatusMessage"
- },
- "targetResource": {
- "readOnly": true,
- "$ref": "#/definitions/TargetResource",
- "description": "The target resource."
- },
- "request": {
- "readOnly": true,
- "$ref": "#/definitions/HttpMessage",
- "description": "The HTTP request message."
- },
- "response": {
- "readOnly": true,
- "$ref": "#/definitions/HttpMessage",
- "description": "The HTTP response message."
- }
- },
- "description": "Deployment operation properties."
- },
- "DeploymentOperation": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "Full deployment operation ID."
- },
- "operationId": {
- "readOnly": true,
- "type": "string",
- "description": "Deployment operation ID."
- },
- "properties": {
- "$ref": "#/definitions/DeploymentOperationProperties",
- "description": "Deployment properties."
- }
- },
- "description": "Deployment operation information."
- },
- "DeploymentOperationsListResult": {
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/DeploymentOperation"
- },
- "description": "An array of deployment operations."
- },
- "nextLink": {
- "readOnly": true,
- "type": "string",
- "description": "The URL to use for getting the next set of results."
- }
- },
- "description": "List of deployment operations."
- },
- "ResourceProviderOperationDisplayProperties": {
- "properties": {
- "publisher": {
- "type": "string",
- "description": "Operation description."
- },
- "provider": {
- "type": "string",
- "description": "Operation provider."
- },
- "resource": {
- "type": "string",
- "description": "Operation resource."
- },
- "operation": {
- "type": "string",
- "description": "Resource provider operation."
- },
- "description": {
- "type": "string",
- "description": "Operation description."
- }
- },
- "description": "Resource provider operation's display properties."
- },
- "Resource": {
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "Resource ID"
- },
- "name": {
- "readOnly": true,
- "type": "string",
- "description": "Resource name"
- },
- "type": {
- "readOnly": true,
- "type": "string",
- "description": "Resource type"
- },
- "location": {
- "type": "string",
- "description": "Resource location"
- },
- "extendedLocation": {
- "$ref": "#/definitions/ExtendedLocation",
- "x-ms-mutability": [
- "read",
- "create"
- ],
- "description": "Resource extended location."
- },
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Resource tags"
- }
- },
- "x-ms-azure-resource": true,
- "description": "Specified resource."
- },
- "SubResource": {
- "properties": {
- "id": {
- "type": "string",
- "description": "Resource ID"
- }
- },
- "x-ms-azure-resource": true,
- "description": "Sub-resource."
- },
- "ResourceGroupExportResult": {
- "properties": {
- "template": {
- "type": "object",
- "description": "The template content."
- },
- "error": {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
- "description": "The template export error."
- }
- },
- "description": "Resource group export result."
- },
- "Operation": {
- "description": "Microsoft.Resources operation",
- "type": "object",
- "properties": {
- "name": {
- "description": "Operation name: {provider}/{resource}/{operation}",
- "type": "string"
- },
- "display": {
- "description": "The object that represents the operation.",
- "properties": {
- "provider": {
- "description": "Service provider: Microsoft.Resources",
- "type": "string"
- },
- "resource": {
- "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
- "type": "string"
- },
- "operation": {
- "description": "Operation type: Read, write, delete, etc.",
- "type": "string"
- },
- "description": {
- "description": "Description of the operation.",
- "type": "string"
- }
- }
- }
- }
- },
- "OperationListResult": {
- "description": "Result of the request to list Microsoft.Resources 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.Resources operations."
- },
- "nextLink": {
- "type": "string",
- "description": "URL to get the next set of operation list results if there are any."
- }
- }
- },
- "TemplateHashResult": {
- "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.",
- "properties": {
- "minifiedTemplate": {
- "type": "string",
- "description": "The minified template string."
- },
- "templateHash": {
- "type": "string",
- "description": "The template hash."
- }
- }
- },
- "WhatIfPropertyChange": {
- "required": [
- "path",
- "propertyChangeType"
- ],
- "properties": {
- "path": {
- "type": "string",
- "description": "The path of the property."
- },
- "propertyChangeType": {
- "type": "string",
- "description": "The type of property change.",
- "enum": [
- "Create",
- "Delete",
- "Modify",
- "Array",
- "NoEffect"
- ],
- "x-ms-enum": {
- "name": "PropertyChangeType",
- "modelAsString": false,
- "values": [
- {
- "value": "Create",
- "description": "The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed."
- },
- {
- "value": "Delete",
- "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed."
- },
- {
- "value": "Modify",
- "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed."
- },
- {
- "value": "Array",
- "description": "The property is an array and contains nested changes."
- },
- {
- "value": "NoEffect",
- "description": "The property will not be set or updated."
- }
- ]
- }
- },
- "before": {
- "type": "object",
- "description": "The value of the property before the deployment is executed."
- },
- "after": {
- "type": "object",
- "description": "The value of the property after the deployment is executed."
- },
- "children": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/WhatIfPropertyChange"
- },
- "description": "Nested property changes."
- }
- },
- "description": "The predicted change to the resource property."
- },
- "WhatIfChange": {
- "description": "Information about a single resource change predicted by What-If operation.",
- "required": [
- "resourceId",
- "changeType"
- ],
- "properties": {
- "resourceId": {
- "type": "string",
- "description": "Resource ID"
- },
- "changeType": {
- "type": "string",
- "description": "Type of change that will be made to the resource when the deployment is executed.",
- "enum": [
- "Create",
- "Delete",
- "Ignore",
- "Deploy",
- "NoChange",
- "Modify",
- "Unsupported"
- ],
- "x-ms-enum": {
- "name": "ChangeType",
- "modelAsString": false,
- "values": [
- {
- "value": "Create",
- "description": "The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed."
- },
- {
- "value": "Delete",
- "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed."
- },
- {
- "value": "Ignore",
- "description": "The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed."
- },
- {
- "value": "Deploy",
- "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change."
- },
- {
- "value": "NoChange",
- "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change."
- },
- {
- "value": "Modify",
- "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change."
- },
- {
- "value": "Unsupported",
- "description": "The resource is not supported by What-If."
- }
- ]
- }
- },
- "unsupportedReason": {
- "type": "string",
- "description": "The explanation about why the resource is unsupported by What-If."
- },
- "before": {
- "type": "object",
- "description": "The snapshot of the resource before the deployment is executed."
- },
- "after": {
- "type": "object",
- "description": "The predicted snapshot of the resource after the deployment is executed."
- },
- "delta": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/WhatIfPropertyChange"
- },
- "description": "The predicted changes to resource properties."
- }
- }
- },
- "WhatIfOperationProperties": {
- "description": "Deployment operation properties.",
- "properties": {
- "changes": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/WhatIfChange"
- },
- "description": "List of resource changes predicted by What-If operation."
- }
- }
- },
- "WhatIfOperationResult": {
- "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.",
- "properties": {
- "status": {
- "type": "string",
- "description": "Status of the What-If operation."
- },
- "properties": {
- "x-ms-client-flatten": true,
- "$ref": "#/definitions/WhatIfOperationProperties",
- "description": "What-If operation properties."
- },
- "error": {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
- "description": "Error when What-If operation fails."
- }
- }
- },
- "Tags": {
- "description": "A dictionary of name and value pairs.",
- "properties": {
- "tags": {
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "description": "The tag value."
- }
- }
- }
- },
- "TagsPatchResource": {
- "type": "object",
- "description": "Wrapper resource for tags patch API request only.",
- "properties": {
- "operation": {
- "type": "string",
- "description": "The operation type for the patch API.",
- "enum": [
- "Replace",
- "Merge",
- "Delete"
- ],
- "x-ms-enum": {
- "name": "tagsPatchOperation",
- "modelAsString": true,
- "values": [
- {
- "value": "Replace",
- "description": "The 'replace' option replaces the entire set of existing tags with a new set."
- },
- {
- "value": "Merge",
- "description": "The 'merge' option allows adding tags with new names and updating the values of tags with existing names."
- },
- {
- "value": "Delete",
- "description": "The 'delete' option allows selectively deleting tags based on given names or name/value pairs."
- }
- ]
- }
- },
- "properties": {
- "$ref": "#/definitions/Tags",
- "description": "The set of tags."
- }
- }
- },
- "TagsResource": {
- "type": "object",
- "description": "Wrapper resource for tags API requests and responses.",
- "required": [
- "properties"
- ],
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The ID of the tags wrapper resource."
- },
- "name": {
- "readOnly": true,
- "type": "string",
- "description": "The name of the tags wrapper resource."
- },
- "type": {
- "readOnly": true,
- "type": "string",
- "description": "The type of the tags wrapper resource."
- },
- "properties": {
- "$ref": "#/definitions/Tags",
- "description": "The set of tags."
- }
- },
- "x-ms-azure-resource": true
- },
- "StatusMessage": {
- "type": "object",
- "description": "Operation status message object.",
- "properties": {
- "status": {
- "type": "string",
- "description": "Status of the deployment operation."
- },
- "error": {
- "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse",
- "description": "The error reported by the operation."
- }
- }
- },
- "ExpressionEvaluationOptions": {
- "properties": {
- "scope": {
- "type": "string",
- "description": "The scope to be used for evaluation of parameters, variables and functions in a nested template.",
- "enum": [
- "NotSpecified",
- "Outer",
- "Inner"
- ],
- "x-ms-enum": {
- "name": "ExpressionEvaluationOptionsScopeType",
- "modelAsString": true
- }
- }
- },
- "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template."
- },
- "ZoneMapping": {
- "type": "object",
- "properties": {
- "location": {
- "type": "string",
- "description": "The location of the zone mapping."
- },
- "zones": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "parameters": {
- "ScopeParameter": {
- "name": "scope",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The resource scope.",
- "x-ms-parameter-location": "method",
- "x-ms-skip-url-encoding": true
- },
- "GroupIdParameter": {
- "name": "groupId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The management group ID.",
- "x-ms-parameter-location": "method",
- "minLength": 1,
- "maxLength": 90
- },
- "SubscriptionIdParameter": {
- "name": "subscriptionId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the target subscription."
- },
- "DeploymentNameParameter": {
- "name": "deploymentName",
- "in": "path",
- "required": true,
- "type": "string",
- "pattern": "^[-\\w\\._\\(\\)]+$",
- "x-ms-parameter-location": "method",
- "minLength": 1,
- "maxLength": 64,
- "description": "The name of the deployment."
- },
- "ApiVersionParameter": {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for this operation."
- }
- }
-}
From bf462bd54260e3a04a6a7b76180c575492b651c3 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 10:58:35 -0700
Subject: [PATCH 14/37] Operations
---
.../stable/2022-12-01/subscriptions.json | 25 +++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 0652225a7593..fbb436f60780 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -34,6 +34,31 @@
}
},
"paths": {
+ "/providers/Microsoft.Resources/operations": {
+ "get": {
+ "tags": [
+ "Operations"
+ ],
+ "operationId": "Operations_List",
+ "description": "Lists all of the available Microsoft.Resources REST API operations.",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The request has succeeded.",
+ "schema": {
+ "$ref": "#/definitions/OperationListResult"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
"/subscriptions/{subscriptionId}/locations": {
"get": {
"tags": [
From bdf5fba9b422e485089772c9f7c91303da3fa683 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 11:15:29 -0700
Subject: [PATCH 15/37] Swagger ModelValidation fix
---
.../2022-12-01/examples/GetLocations.json | 132 ++++++------
.../GetLocationsWithExtendedLocations.json | 190 +++++++++---------
2 files changed, 163 insertions(+), 159 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
index 0b840a6babe1..179dc1ba4493 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
@@ -5,80 +5,82 @@
},
"responses": {
"200": {
- "body": [
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
- "name": "eastus",
- "type": "Region",
- "displayName": "East US",
- "regionalDisplayName": "(US) East US",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Recommended",
- "geography": "United States",
- "geographyGroup": "US",
- "longitude": "-79.8164",
- "latitude": "37.3719",
- "physicalLocation": "Virginia",
- "pairedRegion": [
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus-az3"
+ },
{
- "name": "westus",
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ "logicalZone": "3",
+ "physicalZone": "eastus-az2"
}
]
},
- "availabilityZoneMappings": [
- {
- "logicalZone": "1",
- "physicalZone": "eastus-az1"
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ }
+ ]
},
- {
- "logicalZone": "2",
- "physicalZone": "eastus-az3"
- },
- {
- "logicalZone": "3",
- "physicalZone": "eastus-az2"
- }
- ]
- },
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
- "name": "eastus2",
- "type": "Region",
- "displayName": "East US 2",
- "regionalDisplayName": "(US) East US 2",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Recommended",
- "geography": "United States",
- "geographyGroup": "US",
- "longitude": "-78.3889",
- "latitude": "36.6681",
- "physicalLocation": "Virginia",
- "pairedRegion": [
+ "availabilityZoneMappings": [
{
- "name": "centralus",
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ "logicalZone": "1",
+ "physicalZone": "eastus2-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus2-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus2-az2"
}
]
- },
- "availabilityZoneMappings": [
- {
- "logicalZone": "1",
- "physicalZone": "eastus2-az1"
- },
- {
- "logicalZone": "2",
- "physicalZone": "eastus2-az3"
- },
- {
- "logicalZone": "3",
- "physicalZone": "eastus2-az2"
}
- ]
- }
- ]
+ ]
+ }
}
}
}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
index 2313a5ba9b5c..5bd26c181929 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
@@ -6,110 +6,112 @@
},
"responses": {
"200": {
- "body": [
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
- "name": "eastus",
- "type": "Region",
- "displayName": "East US",
- "regionalDisplayName": "(US) East US",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Recommended",
- "geography": "United States",
- "geographyGroup": "US",
- "longitude": "-79.8164",
- "latitude": "37.3719",
- "physicalLocation": "Virginia",
- "pairedRegion": [
+ "body": {
+ "value": [
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
+ "name": "eastus",
+ "type": "Region",
+ "displayName": "East US",
+ "regionalDisplayName": "(US) East US",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-79.8164",
+ "latitude": "37.3719",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "westus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ }
+ ]
+ },
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus-az1"
+ },
+ {
+ "logicalZone": "2",
+ "physicalZone": "eastus-az3"
+ },
{
- "name": "westus",
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
+ "logicalZone": "3",
+ "physicalZone": "eastus-az2"
}
]
},
- "availabilityZoneMappings": [
- {
- "logicalZone": "1",
- "physicalZone": "eastus-az1"
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
+ "name": "eastus2",
+ "type": "Region",
+ "displayName": "East US 2",
+ "regionalDisplayName": "(US) East US 2",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Recommended",
+ "geography": "United States",
+ "geographyGroup": "US",
+ "longitude": "-78.3889",
+ "latitude": "36.6681",
+ "physicalLocation": "Virginia",
+ "pairedRegion": [
+ {
+ "name": "centralus",
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ }
+ ]
},
- {
- "logicalZone": "2",
- "physicalZone": "eastus-az3"
- },
- {
- "logicalZone": "3",
- "physicalZone": "eastus-az2"
- }
- ]
- },
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
- "name": "eastus2",
- "type": "Region",
- "displayName": "East US 2",
- "regionalDisplayName": "(US) East US 2",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Recommended",
- "geography": "United States",
- "geographyGroup": "US",
- "longitude": "-78.3889",
- "latitude": "36.6681",
- "physicalLocation": "Virginia",
- "pairedRegion": [
+ "availabilityZoneMappings": [
+ {
+ "logicalZone": "1",
+ "physicalZone": "eastus2-az1"
+ },
{
- "name": "centralus",
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
+ "logicalZone": "2",
+ "physicalZone": "eastus2-az3"
+ },
+ {
+ "logicalZone": "3",
+ "physicalZone": "eastus2-az2"
}
]
},
- "availabilityZoneMappings": [
- {
- "logicalZone": "1",
- "physicalZone": "eastus2-az1"
- },
- {
- "logicalZone": "2",
- "physicalZone": "eastus2-az3"
- },
- {
- "logicalZone": "3",
- "physicalZone": "eastus2-az2"
- }
- ]
- },
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1",
- "name": "ezecustomerlabboston1",
- "type": "EdgeZone",
- "displayName": "EZE Customer Lab Boston 1",
- "regionalDisplayName": "(US) EZE Customer Lab Boston 1",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Extended",
- "geographyGroup": "US",
- "geography": "United States",
- "longitude": "-71.219038",
- "latitude": "42.301218"
- }
- },
- {
- "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1",
- "name": "ezecustomerlabhouston1",
- "type": "EdgeZone",
- "displayName": "EZE Customer Lab Houston 1",
- "regionalDisplayName": "(US) EZE Customer Lab Houston 1",
- "metadata": {
- "regionType": "Physical",
- "regionCategory": "Extended",
- "geographyGroup": "US",
- "geography": "United States",
- "longitude": "-95.41452",
- "latitude": "29.9411"
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1",
+ "name": "ezecustomerlabboston1",
+ "type": "EdgeZone",
+ "displayName": "EZE Customer Lab Boston 1",
+ "regionalDisplayName": "(US) EZE Customer Lab Boston 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "geographyGroup": "US",
+ "geography": "United States",
+ "longitude": "-71.219038",
+ "latitude": "42.301218"
+ }
+ },
+ {
+ "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1",
+ "name": "ezecustomerlabhouston1",
+ "type": "EdgeZone",
+ "displayName": "EZE Customer Lab Houston 1",
+ "regionalDisplayName": "(US) EZE Customer Lab Houston 1",
+ "metadata": {
+ "regionType": "Physical",
+ "regionCategory": "Extended",
+ "geographyGroup": "US",
+ "geography": "United States",
+ "longitude": "-95.41452",
+ "latitude": "29.9411"
+ }
}
- }
- ]
+ ]
+ }
}
}
}
From 99c00c097b5b25c277515d921f905507bd431798 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 12:21:19 -0700
Subject: [PATCH 16/37] Operations api
---
.../stable/2022-12-01/subscriptions.json | 62 +++++++++++++++++++
1 file changed, 62 insertions(+)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index fbb436f60780..d121d53ad467 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -785,6 +785,68 @@
}
}
},
+ "AvailableOperations": {
+ "description": "Available operations of the service",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of available operation details",
+ "uniqueItems": false,
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OperationDetail"
+ }
+ },
+ "nextLink": {
+ "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDetail": {
+ "description": "Operation detail payload",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the operation",
+ "type": "string"
+ },
+ "isDataAction": {
+ "description": "Indicates whether the operation is a data action",
+ "type": "boolean"
+ },
+ "display": {
+ "$ref": "#/definitions/OperationDisplay",
+ "description": "Display of the operation"
+ },
+ "origin": {
+ "description": "Origin of the operation",
+ "type": "string"
+ }
+ }
+ },
+ "OperationDisplay": {
+ "description": "Operation display payload",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "description": "Resource provider of the operation",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Resource of the operation",
+ "type": "string"
+ },
+ "operation": {
+ "description": "Localized friendly name for the operation",
+ "type": "string"
+ },
+ "description": {
+ "description": "Localized friendly description for the operation",
+ "type": "string"
+ }
+ }
+ },
"OperationListResult": {
"type": "object",
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
From eac725ecb1e1b21a9256cd39abb1896fc1e117cf Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 12:40:27 -0700
Subject: [PATCH 17/37] removing previous commit
---
.../stable/2022-12-01/subscriptions.json | 62 -------------------
1 file changed, 62 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index d121d53ad467..fbb436f60780 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -785,68 +785,6 @@
}
}
},
- "AvailableOperations": {
- "description": "Available operations of the service",
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of available operation details",
- "uniqueItems": false,
- "type": "array",
- "items": {
- "$ref": "#/definitions/OperationDetail"
- }
- },
- "nextLink": {
- "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.",
- "type": "string"
- }
- }
- },
- "OperationDetail": {
- "description": "Operation detail payload",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the operation",
- "type": "string"
- },
- "isDataAction": {
- "description": "Indicates whether the operation is a data action",
- "type": "boolean"
- },
- "display": {
- "$ref": "#/definitions/OperationDisplay",
- "description": "Display of the operation"
- },
- "origin": {
- "description": "Origin of the operation",
- "type": "string"
- }
- }
- },
- "OperationDisplay": {
- "description": "Operation display payload",
- "type": "object",
- "properties": {
- "provider": {
- "description": "Resource provider of the operation",
- "type": "string"
- },
- "resource": {
- "description": "Resource of the operation",
- "type": "string"
- },
- "operation": {
- "description": "Localized friendly name for the operation",
- "type": "string"
- },
- "description": {
- "description": "Localized friendly description for the operation",
- "type": "string"
- }
- }
- },
"OperationListResult": {
"type": "object",
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
From d2c6b9e42a70e43b3d08266f06426a0041bded56 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 12:47:28 -0700
Subject: [PATCH 18/37] x-ms-example
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index fbb436f60780..90d65b44a0cb 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -56,9 +56,10 @@
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
+ },
+ "x-ms-examples": {
}
- }
- },
+ },
"/subscriptions/{subscriptionId}/locations": {
"get": {
"tags": [
From f23a8d7f035a61bb7c97a4d73f1bd4176cac3aa2 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 13:05:49 -0700
Subject: [PATCH 19/37] missing curly
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 90d65b44a0cb..0d6940bc9e51 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -59,6 +59,7 @@
},
"x-ms-examples": {
}
+ }
},
"/subscriptions/{subscriptionId}/locations": {
"get": {
From 7da53492a21fd2ef7be5aea90dc3a7f4a939b387 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 29 Mar 2023 13:16:02 -0700
Subject: [PATCH 20/37] default response
---
.../stable/2022-12-01/subscriptions.json | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 0d6940bc9e51..80c6110e3af4 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -52,6 +52,12 @@
"schema": {
"$ref": "#/definitions/OperationListResult"
}
+ },
+ "default": {
+ "description": "Error response describing why the operation failed.",
+ "schema": {
+ "$ref": "#/definitions/CloudError"
+ }
}
},
"x-ms-pageable": {
From dce3c067f8ca1f32092718d798cb70b5f01afc12 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 5 Apr 2023 16:02:22 -0700
Subject: [PATCH 21/37] Prettier errors fixed
---
.../stable/2022-12-01/examples/GetLocations.json | 2 +-
.../examples/GetLocationsWithExtendedLocations.json | 2 +-
.../stable/2022-12-01/subscriptions.json | 12 +++++++-----
3 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
index 179dc1ba4493..b2a7d2e7eb89 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
@@ -80,7 +80,7 @@
]
}
]
- }
+ }
}
}
}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
index 5bd26c181929..fc7defd65158 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
@@ -111,7 +111,7 @@
}
}
]
- }
+ }
}
}
}
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 80c6110e3af4..32ac367dd1e3 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -63,10 +63,9 @@
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
- "x-ms-examples": {
- }
- }
- },
+ "x-ms-examples": {}
+ }
+ },
"/subscriptions/{subscriptionId}/locations": {
"get": {
"tags": [
@@ -842,7 +841,10 @@
"location": {
"type": "string",
"description": "the location of the subscription.",
- "x-ms-mutability": [ "create", "read" ]
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"availabilityZonePeers": {
"type": "array",
From 9b5515afa373a1210e79dd6d137a0468bd65d9d9 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 5 Apr 2023 16:46:45 -0700
Subject: [PATCH 22/37] Operation Schema
---
.../stable/2022-12-01/subscriptions.json | 61 +++++++++++++++----
1 file changed, 49 insertions(+), 12 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 32ac367dd1e3..ad94c3be35c2 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -761,34 +761,71 @@
"description": "An error response for a resource management request."
},
"Operation": {
- "description": "Microsoft.Resources operation",
+ "title": "REST API Operation",
+ "description": "Details of a REST API operation, returned from the Resource Provider Operations API",
"type": "object",
"properties": {
"name": {
- "description": "Operation name: {provider}/{resource}/{operation}",
- "type": "string"
+ "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDataAction": {
+ "description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
+ "type": "boolean",
+ "readOnly": true
},
"display": {
+ "description": "Localized display information for this particular operation.",
"type": "object",
- "description": "The object that represents the operation.",
"properties": {
"provider": {
- "description": "Service provider: Microsoft.Resources",
- "type": "string"
+ "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
+ "type": "string",
+ "readOnly": true
},
"resource": {
- "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
- "type": "string"
+ "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
+ "type": "string",
+ "readOnly": true
},
"operation": {
- "description": "Operation type: Read, write, delete, etc.",
- "type": "string"
+ "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
+ "type": "string",
+ "readOnly": true
},
"description": {
- "description": "Description of the operation.",
- "type": "string"
+ "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
+ "type": "string",
+ "readOnly": true
}
}
+ },
+ "origin": {
+ "description": "The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is \"user,system\"",
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "user",
+ "system",
+ "user,system"
+ ],
+ "x-ms-enum": {
+ "name": "Origin",
+ "modelAsString": true
+ }
+ },
+ "actionType": {
+ "description": "Enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs.",
+ "type": "string",
+ "readOnly": true,
+ "enum": [
+ "Internal"
+ ],
+ "x-ms-enum": {
+ "name": "ActionType",
+ "modelAsString": true
+ }
}
}
},
From 0c1362ad47b1754da517a7cc0b112f78ec554a5a Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 5 Apr 2023 17:12:49 -0700
Subject: [PATCH 23/37] Breaking changes
---
.../stable/2022-12-01/subscriptions.json | 25 ++++++++-----------
1 file changed, 10 insertions(+), 15 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index ad94c3be35c2..9540908d21ac 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -766,9 +766,8 @@
"type": "object",
"properties": {
"name": {
- "description": "The name of the operation, as per Resource-Based Access Control (RBAC). Examples: \"Microsoft.Compute/virtualMachines/write\", \"Microsoft.Compute/virtualMachines/capture/action\"",
- "type": "string",
- "readOnly": true
+ "description": "Operation name: {provider}/{resource}/{operation}",
+ "type": "string"
},
"isDataAction": {
"description": "Whether the operation applies to data-plane. This is \"true\" for data-plane operations and \"false\" for ARM/control-plane operations.",
@@ -780,24 +779,20 @@
"type": "object",
"properties": {
"provider": {
- "description": "The localized friendly form of the resource provider name, e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute\".",
- "type": "string",
- "readOnly": true
+ "description": "Service provider: Microsoft.Resources",
+ "type": "string"
},
"resource": {
- "description": "The localized friendly name of the resource type related to this operation. E.g. \"Virtual Machines\" or \"Job Schedule Collections\".",
- "type": "string",
- "readOnly": true
+ "description": "Resource on which the operation is performed: Profile, endpoint, etc.",
+ "type": "string"
},
"operation": {
- "description": "The concise, localized friendly name for the operation; suitable for dropdowns. E.g. \"Create or Update Virtual Machine\", \"Restart Virtual Machine\".",
- "type": "string",
- "readOnly": true
+ "description": "Operation type: Read, write, delete, etc.",
+ "type": "string"
},
"description": {
- "description": "The short, localized friendly description of the operation; suitable for tool tips and detailed views.",
- "type": "string",
- "readOnly": true
+ "description": "Description of the operation.",
+ "type": "string"
}
}
},
From 1143733543c3e9d1e7e81373c817140e4eeb8d06 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 10:33:40 -0700
Subject: [PATCH 24/37] Staging errror fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 9540908d21ac..db5bdf22ece5 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -825,8 +825,8 @@
}
},
"OperationListResult": {
- "type": "object",
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
+ "type": "object",
"properties": {
"value": {
"type": "array",
From 2430d28aafc84be6bd86752bf06c764a004e2a6e Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 10:49:57 -0700
Subject: [PATCH 25/37] Testing temp fix
---
.../stable/2022-12-01/subscriptions.json | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index db5bdf22ece5..a76e806aabf9 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -825,7 +825,7 @@
}
},
"OperationListResult": {
- "description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
+ "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
"type": "object",
"properties": {
"value": {
@@ -836,11 +836,13 @@
"x-ms-identifiers": [
"name"
],
- "description": "List of Microsoft.Resources operations."
+ "description": "List of operations supported by the resource provider",
+ "readOnly": true
},
"nextLink": {
"type": "string",
- "description": "URL to get the next set of operation list results if there are any."
+ "description": "URL to get the next set of operation list results (if there are any).",
+ "readOnly": true
}
}
},
From fb5f9c83873920164feb02a8c801d201f7690842 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 12:56:43 -0700
Subject: [PATCH 26/37] common-types fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index a76e806aabf9..d5697f72cad4 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -50,7 +50,7 @@
"200": {
"description": "OK. The request has succeeded.",
"schema": {
- "$ref": "#/definitions/OperationListResult"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult"
}
},
"default": {
From e247708382435dfbd034479c2374459bbd77a22b Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 17:02:30 -0700
Subject: [PATCH 27/37] staging lint diff warnings fixed
---
.../stable/2022-12-01/subscriptions.json | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index d5697f72cad4..aa4bf16b4d67 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -43,7 +43,7 @@
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -851,7 +851,11 @@
"properties": {
"location": {
"type": "string",
- "description": "The Microsoft location."
+ "description": "The Microsoft location.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
},
"subscriptionIds": {
"type": "array",
From 290bff7219ddd150377571e112254ba807c87255 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 17:21:35 -0700
Subject: [PATCH 28/37] Testing v4
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index aa4bf16b4d67..77cb13802869 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -43,7 +43,7 @@
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
From 622eb864344b4a01b535c31f85c35f7789394f20 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 17:45:12 -0700
Subject: [PATCH 29/37] v5 common types fix
---
.../stable/2022-12-01/subscriptions.json | 56 +++----------------
1 file changed, 9 insertions(+), 47 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 77cb13802869..4a192c5853d7 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -43,7 +43,7 @@
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -76,10 +76,10 @@
"description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "includeExtendedLocations",
@@ -126,10 +126,10 @@
"description": "Gets details about a specified subscription.",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -162,7 +162,7 @@
"description": "Gets all subscriptions for a tenant.",
"parameters": [
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -198,7 +198,7 @@
"description": "Gets the tenants for your account.",
"parameters": [
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -234,10 +234,10 @@
"description": "Compares a subscriptions logical zone mapping",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "parameters",
@@ -824,28 +824,6 @@
}
}
},
- "OperationListResult": {
- "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
- "type": "object",
- "properties": {
- "value": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Operation"
- },
- "x-ms-identifiers": [
- "name"
- ],
- "description": "List of operations supported by the resource provider",
- "readOnly": true
- },
- "nextLink": {
- "type": "string",
- "description": "URL to get the next set of operation list results (if there are any).",
- "readOnly": true
- }
- }
- },
"CheckZonePeersRequest": {
"type": "object",
"properties": {
@@ -936,14 +914,6 @@
}
},
"parameters": {
- "SubscriptionIdParameter": {
- "name": "subscriptionId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the target subscription.",
- "x-ms-parameter-location": "method"
- },
"CheckResourceNameParameter": {
"description": "Resource object with values for resource name and resource type",
"in": "body",
@@ -952,14 +922,6 @@
"$ref": "#/definitions/ResourceName"
},
"x-ms-parameter-location": "method"
- },
- "ApiVersionParameter": {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-parameter-location": "client"
}
}
}
From 6fe5136b6436e6b74f0c3a7f3bbad955df598144 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 18:05:14 -0700
Subject: [PATCH 30/37] Rollback
---
.../stable/2022-12-01/subscriptions.json | 56 ++++++++++++++++---
1 file changed, 47 insertions(+), 9 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 4a192c5853d7..77cb13802869 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -43,7 +43,7 @@
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -76,10 +76,10 @@
"description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "includeExtendedLocations",
@@ -126,10 +126,10 @@
"description": "Gets details about a specified subscription.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -162,7 +162,7 @@
"description": "Gets all subscriptions for a tenant.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -198,7 +198,7 @@
"description": "Gets the tenants for your account.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -234,10 +234,10 @@
"description": "Compares a subscriptions logical zone mapping",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
+ "$ref": "#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
+ "$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "parameters",
@@ -824,6 +824,28 @@
}
}
},
+ "OperationListResult": {
+ "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Operation"
+ },
+ "x-ms-identifiers": [
+ "name"
+ ],
+ "description": "List of operations supported by the resource provider",
+ "readOnly": true
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of operation list results (if there are any).",
+ "readOnly": true
+ }
+ }
+ },
"CheckZonePeersRequest": {
"type": "object",
"properties": {
@@ -914,6 +936,14 @@
}
},
"parameters": {
+ "SubscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The ID of the target subscription.",
+ "x-ms-parameter-location": "method"
+ },
"CheckResourceNameParameter": {
"description": "Resource object with values for resource name and resource type",
"in": "body",
@@ -922,6 +952,14 @@
"$ref": "#/definitions/ResourceName"
},
"x-ms-parameter-location": "method"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The API version to use for the operation.",
+ "x-ms-parameter-location": "client"
}
}
}
From 9fa1aa152cbae60a26f05071e31962089da86e3d Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 18:19:26 -0700
Subject: [PATCH 31/37] common-types fix
---
.../stable/2022-12-01/subscriptions.json | 20 +++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 77cb13802869..7edd49c1c491 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -43,7 +43,7 @@
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
- "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -76,10 +76,10 @@
"description": "This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "includeExtendedLocations",
@@ -126,10 +126,10 @@
"description": "Gets details about a specified subscription.",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -162,7 +162,7 @@
"description": "Gets all subscriptions for a tenant.",
"parameters": [
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -198,7 +198,7 @@
"description": "Gets the tenants for your account.",
"parameters": [
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
@@ -234,10 +234,10 @@
"description": "Compares a subscriptions logical zone mapping",
"parameters": [
{
- "$ref": "#/parameters/SubscriptionIdParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "parameters",
@@ -286,7 +286,7 @@
"$ref": "#/parameters/CheckResourceNameParameter"
},
{
- "$ref": "#/parameters/ApiVersionParameter"
+ "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
From e1ecc95368bde01831e58f6ceb4848d1e7117961 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 18:31:20 -0700
Subject: [PATCH 32/37] Removing redundant parameters
---
.../stable/2022-12-01/subscriptions.json | 16 ----------------
1 file changed, 16 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 7edd49c1c491..a42e2c549dcf 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -936,14 +936,6 @@
}
},
"parameters": {
- "SubscriptionIdParameter": {
- "name": "subscriptionId",
- "in": "path",
- "required": true,
- "type": "string",
- "description": "The ID of the target subscription.",
- "x-ms-parameter-location": "method"
- },
"CheckResourceNameParameter": {
"description": "Resource object with values for resource name and resource type",
"in": "body",
@@ -952,14 +944,6 @@
"$ref": "#/definitions/ResourceName"
},
"x-ms-parameter-location": "method"
- },
- "ApiVersionParameter": {
- "name": "api-version",
- "in": "query",
- "required": true,
- "type": "string",
- "description": "The API version to use for the operation.",
- "x-ms-parameter-location": "client"
}
}
}
From ee888d2893945c4441af1633d1a9935c69e70de7 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 18:33:11 -0700
Subject: [PATCH 33/37] Model validation fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index a42e2c549dcf..97f4c8b28bcf 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -628,7 +628,7 @@
"tenantId": {
"readOnly": true,
"type": "string",
- "description": "The tenant ID. For example, 00000000-0000-0000-0000-000000000000."
+ "description": "The tenant ID. For example, 00000000-0000-0000-0000-00000000000000."
},
"tenantCategory": {
"readOnly": true,
From 1dbbd65ba363b1f4f6ca522abcf39059dbc8082b Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Fri, 7 Apr 2023 18:42:18 -0700
Subject: [PATCH 34/37] GUID fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 97f4c8b28bcf..8f3bd789c13b 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -628,7 +628,7 @@
"tenantId": {
"readOnly": true,
"type": "string",
- "description": "The tenant ID. For example, 00000000-0000-0000-0000-00000000000000."
+ "description": "The tenant ID. For example, 00000000-0000-0000-0000-00000000000000"
},
"tenantCategory": {
"readOnly": true,
From ebe59c92d393d8ad56343995fc588b84584ed14e Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Wed, 12 Apr 2023 10:13:29 -0700
Subject: [PATCH 35/37] uuid fix
---
.../Microsoft.Resources/stable/2022-12-01/subscriptions.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 8f3bd789c13b..9b9eef7fdab8 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -628,7 +628,7 @@
"tenantId": {
"readOnly": true,
"type": "string",
- "description": "The tenant ID. For example, 00000000-0000-0000-0000-00000000000000"
+ "description": "The tenant ID. For example, 8d65815f-a5b6-402f-9298-045155da7d74"
},
"tenantCategory": {
"readOnly": true,
From 7e59b80632a8eacac4b4518333b05087ffdcca70 Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Mon, 17 Apr 2023 10:40:35 -0700
Subject: [PATCH 36/37] ReadOnlyPropertChanged error fixed
---
.../stable/2022-12-01/subscriptions.json | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index 9b9eef7fdab8..d8c9ff08026a 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -836,13 +836,11 @@
"x-ms-identifiers": [
"name"
],
- "description": "List of operations supported by the resource provider",
- "readOnly": true
+ "description": "List of operations supported by the resource provider"
},
"nextLink": {
"type": "string",
- "description": "URL to get the next set of operation list results (if there are any).",
- "readOnly": true
+ "description": "URL to get the next set of operation list results (if there are any)."
}
}
},
From ee5e4459879e0b55db1722dcac07921d243eea9c Mon Sep 17 00:00:00 2001
From: Gaurav Kumar
Date: Mon, 17 Apr 2023 10:54:20 -0700
Subject: [PATCH 37/37] uuid fix
---
.../stable/2022-12-01/examples/PostCheckZonePeers.json | 4 ++--
.../stable/2022-12-01/subscriptions.json | 8 ++++----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
index 3e2282e59be9..f5b462a149a2 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/PostCheckZonePeers.json
@@ -1,6 +1,6 @@
{
"parameters": {
- "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "subscriptionId": "8d65815f-a5b6-402f-9298-045155da7d74",
"api-version": "2022-12-01",
"parameters": {
"location": "eastus",
@@ -12,7 +12,7 @@
"responses": {
"200": {
"body": {
- "subscriptionId": "00000000-0000-0000-0000-00000000000000",
+ "subscriptionId": "8d65815f-a5b6-402f-9298-045155da7d74",
"location": "eastus2",
"availabilityZonePeers": [
{
diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
index d8c9ff08026a..81ffb3c224aa 100644
--- a/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
+++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/subscriptions.json
@@ -324,7 +324,7 @@
"id": {
"readOnly": true,
"type": "string",
- "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ "description": "The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus."
},
"subscriptionId": {
"readOnly": true,
@@ -425,7 +425,7 @@
"id": {
"readOnly": true,
"type": "string",
- "description": "The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus."
+ "description": "The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus."
},
"subscriptionId": {
"readOnly": true,
@@ -494,7 +494,7 @@
"id": {
"readOnly": true,
"type": "string",
- "description": "The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000."
+ "description": "The fully qualified ID for the subscription. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74"
},
"subscriptionId": {
"readOnly": true,
@@ -623,7 +623,7 @@
"id": {
"readOnly": true,
"type": "string",
- "description": "The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000."
+ "description": "The fully qualified ID of the tenant. For example, /tenants/8d65815f-a5b6-402f-9298-045155da7d74"
},
"tenantId": {
"readOnly": true,