diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json index c44fc3aad6e0..b4b6657b42b1 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json @@ -2278,11 +2278,11 @@ "items": { "type": "string" }, - "description": "The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json index 02ab6f8245a5..3cacb214c0c7 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json @@ -2287,11 +2287,11 @@ "items": { "type": "string" }, - "description": "The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json index 91e6cf5a9c4c..2a1ff908ab4a 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json @@ -2537,11 +2537,11 @@ "items": { "type": "string" }, - "description": "The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json index cd2e78948043..b6db696c8834 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json @@ -2615,11 +2615,11 @@ "items": { "type": "string" }, - "description": "The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json index 367dcb9f9503..57793027cd77 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json @@ -2681,11 +2681,11 @@ "items": { "type": "string" }, - "description": "The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index eb5b46fc00c6..c8100b2deea3 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -3148,11 +3148,11 @@ "items": { "type": "string" }, - "description": "The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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." diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroup.json new file mode 100644 index 000000000000..5f0c654df9a3 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "eaee6a92-e973-4922-9471-3a0a6abf81cd", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-05-01", + "parameters": { + "resources": [ + "*" + ], + "options": "IncludeParameterDefaultValue,IncludeComments" + } + }, + "responses": { + "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":[ + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroupWithFiltering.json new file mode 100644 index 000000000000..9584f3bd194f --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/examples/ExportResourceGroupWithFiltering.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "eaee6a92-e973-4922-9471-3a0a6abf81cd", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-05-01", + "parameters": { + "resources": [ + "/subscriptions/eaee6a92-e973-4922-9471-3a0a6abf81cd/resourceGroups/myResourceGroup/providers/My.RP/myResourceType/myFirstResource" + ], + "options": "SkipResourceNameParameterization" + } + }, + "responses": { + "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')]" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/resources.json index e99b3dd7f330..07ee2550da0b 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-03-01/resources.json @@ -1215,6 +1215,14 @@ "$ref": "#/parameters/SubscriptionIdParameter" } ], + "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.", @@ -3157,11 +3165,11 @@ "items": { "type": "string" }, - "description": "The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources." + "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. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + "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."